{ "data": { "__schema": { "queryType": { "name": "Query" }, "mutationType": { "name": "Mutation" }, "subscriptionType": null, "types": [ { "kind": "OBJECT", "name": "Query", "description": "", "fields": [ { "name": "availableStores", "description": "Get a list of available store views and their config information.", "args": [ { "name": "useCurrentGroup", "description": "Filter store views by current store group", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null } ], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "StoreConfig", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "cart", "description": "Returns information about shopping cart", "args": [ { "name": "cart_id", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Cart", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "categories", "description": null, "args": [ { "name": "filters", "description": "Identifies which Category filter inputs to search for and return.", "type": { "kind": "INPUT_OBJECT", "name": "CategoryFilterInput", "ofType": null }, "defaultValue": null }, { "name": "pageSize", "description": "Specifies the maximum number of results to return at once. This attribute is optional.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": "20" }, { "name": "currentPage", "description": "Specifies which page of results to return. The default value is 1.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": "1" } ], "type": { "kind": "OBJECT", "name": "CategoryResult", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "category", "description": "The category query searches for categories that match the criteria specified in the search and filter attributes.", "args": [ { "name": "id", "description": "Id of the category.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CategoryTree", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use 'categoryList' query instead of 'category' query" }, { "name": "categoryList", "description": "Returns an array of categories based on the specified filters.", "args": [ { "name": "filters", "description": "Identifies which Category filter inputs to search for and return.", "type": { "kind": "INPUT_OBJECT", "name": "CategoryFilterInput", "ofType": null }, "defaultValue": null } ], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "CategoryTree", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "checkoutAgreements", "description": "The Checkout Agreements information", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "CheckoutAgreement", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "cmsBlocks", "description": "The CMS block query returns information about CMS blocks", "args": [ { "name": "identifiers", "description": "Identifiers of the CMS blocks", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CmsBlocks", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "cmsPage", "description": "The CMS page query returns information about a CMS page", "args": [ { "name": "id", "description": "Id of the CMS page", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "identifier", "description": "Identifier of the CMS page", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CmsPage", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "compareList", "description": "Return products that have been added to the specified compare list", "args": [ { "name": "uid", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CompareList", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "countries", "description": "The countries query provides information for all countries.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "Country", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "country", "description": "The countries query provides information for a single country.", "args": [ { "name": "id", "description": "", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Country", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "currency", "description": "The currency query returns information about store currency.", "args": [], "type": { "kind": "OBJECT", "name": "Currency", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "customAttributeMetadata", "description": "The customAttributeMetadata query returns the attribute type, given an attribute code and entity type", "args": [ { "name": "attributes", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "AttributeInput", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CustomAttributeMetadata", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "customer", "description": "The customer query returns information about a customer account", "args": [], "type": { "kind": "OBJECT", "name": "Customer", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerCart", "description": "Returns information about the customer shopping cart", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Cart", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerDownloadableProducts", "description": "The query returns the contents of a customer's downloadable products", "args": [], "type": { "kind": "OBJECT", "name": "CustomerDownloadableProducts", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "customerOrders", "description": null, "args": [], "type": { "kind": "OBJECT", "name": "CustomerOrders", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use orders from customer instead" }, { "name": "customerPaymentTokens", "description": "Return a list of customer payment tokens", "args": [], "type": { "kind": "OBJECT", "name": "CustomerPaymentTokens", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "getHostedProUrl", "description": "Retrieve secure PayPal url for Payments Pro Hosted Solution transaction.", "args": [ { "name": "input", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "HostedProUrlInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "HostedProUrl", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "getPayflowLinkToken", "description": "Retrieve payment credentials for transaction. Use this query for Payflow Link and Payments Advanced payment methods.", "args": [ { "name": "input", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "PayflowLinkTokenInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PayflowLinkToken", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "giftCardAccount", "description": "Get information for gift card account by code", "args": [ { "name": "input", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "GiftCardAccountInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "GiftCardAccount", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "isEmailAvailable", "description": null, "args": [ { "name": "email", "description": "The new customer email", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "IsEmailAvailableOutput", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "pickupLocations", "description": "The pickup locations query searches for locations that match the search request requirements.", "args": [ { "name": "area", "description": "Perform search by location using radius and search term.", "type": { "kind": "INPUT_OBJECT", "name": "AreaInput", "ofType": null }, "defaultValue": null }, { "name": "filters", "description": "Apply filters by attributes.", "type": { "kind": "INPUT_OBJECT", "name": "PickupLocationFilterInput", "ofType": null }, "defaultValue": null }, { "name": "sort", "description": "Specifies which attribute to sort on, and whether to return the results in ascending or descending order.", "type": { "kind": "INPUT_OBJECT", "name": "PickupLocationSortInput", "ofType": null }, "defaultValue": null }, { "name": "pageSize", "description": "The maximum number of pickup locations to return at once. The attribute is optional.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": "20" }, { "name": "currentPage", "description": "Specifies which page of results to return. The default value is 1.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": "1" }, { "name": "productsInfo", "description": "Information about products which should be delivered.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "ProductInfoInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PickupLocations", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "productReviewRatingsMetadata", "description": "Retrieves metadata required by clients to render the Reviews section.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductReviewRatingsMetadata", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "products", "description": "The products query searches for products that match the criteria specified in the search and filter attributes.", "args": [ { "name": "search", "description": "Performs a full-text search using the specified key words.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "filter", "description": "Identifies which product attributes to search for and return.", "type": { "kind": "INPUT_OBJECT", "name": "ProductAttributeFilterInput", "ofType": null }, "defaultValue": null }, { "name": "pageSize", "description": "Specifies the maximum number of results to return at once. This attribute is optional.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": "20" }, { "name": "currentPage", "description": "Specifies which page of results to return. The default value is 1.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": "1" }, { "name": "sort", "description": "Specifies which attributes to sort on, and whether to return the results in ascending or descending order.", "type": { "kind": "INPUT_OBJECT", "name": "ProductAttributeSortInput", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Products", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "storeConfig", "description": "The store config query", "args": [], "type": { "kind": "OBJECT", "name": "StoreConfig", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "urlResolver", "description": "The urlResolver query returns the relative URL for a specified product, category or CMS page, using as input a url_key appended by the url_suffix, if one exists", "args": [ { "name": "url", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "EntityUrl", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "wishlist", "description": "The wishlist query returns the contents of a customer's wish list", "args": [], "type": { "kind": "OBJECT", "name": "WishlistOutput", "ofType": null }, "isDeprecated": true, "deprecationReason": "Moved under `Customer` `wishlist`" } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "SCALAR", "name": "Boolean", "description": "The `Boolean` scalar type represents `true` or `false`.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "StoreConfig", "description": "The type contains information about a store config", "fields": [ { "name": "absolute_footer", "description": "Footer Miscellaneous HTML", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "allow_gift_receipt", "description": "Allow Gift Receipt", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "allow_gift_wrapping_on_order", "description": "Allow Gift Wrapping on Order Level", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "allow_gift_wrapping_on_order_items", "description": "Allow Gift Wrapping for Order Items", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "allow_guests_to_write_product_reviews", "description": "Indicates whether guest users can write product reviews. Possible values: 1 (Yes) and 0 (No)", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "allow_items", "description": "The value of the Allow Gift Messages for Order Items option", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "allow_order", "description": "The value of the Allow Gift Messages on Order Level option", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "allow_printed_card", "description": "Allow Printed Card", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "autocomplete_on_storefront", "description": "Enable autocomplete on login and forgot password forms", "args": [], "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "base_currency_code", "description": "Base currency code", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "base_link_url", "description": "Base link URL for the store", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "base_media_url", "description": "Base media URL for the store", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "base_static_url", "description": "Base static URL for the store", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "base_url", "description": "Base URL for the store", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "braintree_cc_vault_active", "description": "Braintree cc vault status.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "cart_gift_wrapping", "description": "Display Gift Wrapping Prices", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "cart_printed_card", "description": "Display Printed Card Prices", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "catalog_default_sort_by", "description": "Default Sort By.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "category_fixed_product_tax_display_setting", "description": "Corresponds to the 'Display Prices In Product Lists' field. It indicates how FPT information is displayed on category pages", "args": [], "type": { "kind": "ENUM", "name": "FixedProductTaxDisplaySettings", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "category_url_suffix", "description": "Category URL Suffix.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "cms_home_page", "description": "CMS Home Page", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "cms_no_cookies", "description": "CMS No Cookies Page", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "cms_no_route", "description": "CMS No Route Page", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "code", "description": "A code assigned to the store to identify it", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `store_code` instead." }, { "name": "configurable_thumbnail_source", "description": "The configuration setting determines which thumbnail should be used in the cart for configurable products.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "copyright", "description": "Copyright", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "default_description", "description": "Default Meta Description", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "default_display_currency_code", "description": "Default display currency code", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "default_keywords", "description": "Default Meta Keywords", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "default_title", "description": "Default Page Title", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "demonotice", "description": "Display Demo Store Notice", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "enable_multiple_wishlists", "description": "Indicates whether customers can have multiple wish lists. Possible values: 1 (Yes) and 0 (No)", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "front", "description": "Default Web URL", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "grid_per_page", "description": "Products per Page on Grid Default Value.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "grid_per_page_values", "description": "Products per Page on Grid Allowed Values.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "head_includes", "description": "Scripts and Style Sheets", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "head_shortcut_icon", "description": "Favicon Icon", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "header_logo_src", "description": "Logo Image", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The ID number assigned to the store", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `store_code` instead." }, { "name": "is_default_store", "description": "Indicates whether the store view has been designated as the default within the store group", "args": [], "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "is_default_store_group", "description": "Indicates whether the store group has been designated as the default within the website", "args": [], "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "list_mode", "description": "List Mode.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "list_per_page", "description": "Products per Page on List Default Value.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "list_per_page_values", "description": "Products per Page on List Allowed Values.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "locale", "description": "Store locale", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "logo_alt", "description": "Logo Image Alt", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "logo_height", "description": "Logo Attribute Height", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "logo_width", "description": "Logo Attribute Width", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "magento_reward_general_is_enabled", "description": "Reward points functionality status: enabled/disabled", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "magento_reward_general_is_enabled_on_front", "description": "Reward points functionality status on the storefront: enabled/disabled", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "magento_reward_general_min_points_balance", "description": "Reward points redemption minimum threshold", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "magento_reward_general_publish_history", "description": "Enable reward points history for the customer", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "magento_reward_points_invitation_customer", "description": "Number of points for referral, when invitee registers on the site", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "magento_reward_points_invitation_customer_limit", "description": "Maximum number of registration referrals that will qualify for rewards", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "magento_reward_points_invitation_order", "description": "Number of points for referral, when invitee places an initial order on the site", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "magento_reward_points_invitation_order_limit", "description": "Maximum number of order placements by invitees that will qualify for rewards", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "magento_reward_points_newsletter", "description": "Number of points for newsletter subscription", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "magento_reward_points_order", "description": "Whether customer earns points for shopping according to the reward point exchange rate. In Luma this also controls whether to show a message in shopping cart about the rewards points earned for the purchase, as well as the customer’s current reward point balance", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "magento_reward_points_register", "description": "Number of points customer gets for registration", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "magento_reward_points_review", "description": "Number of points for writing a review", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "magento_reward_points_review_limit", "description": "Maximum number of reviews that will qualify for the rewards", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "magento_wishlist_general_is_enabled", "description": "Indicates whether wishlists are enabled (1) or disabled (0)", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "maximum_number_of_wishlists", "description": "If multiple wish lists are enabled, the maximum number of wish lists the customer can have", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "minimum_password_length", "description": "The minimum number of characters required for a valid password.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "no_route", "description": "Default No-route URL", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "payment_payflowpro_cc_vault_active", "description": "Payflow Pro vault status.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "printed_card_price", "description": "Default Price for Printed Card", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_fixed_product_tax_display_setting", "description": "Corresponds to the 'Display Prices On Product View Page' field. It indicates how FPT information is displayed on product pages", "args": [], "type": { "kind": "ENUM", "name": "FixedProductTaxDisplaySettings", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_reviews_enabled", "description": "Indicates whether product reviews are enabled. Possible values: 1 (Yes) and 0 (No)", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_url_suffix", "description": "Product URL Suffix.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "required_character_classes_number", "description": "The number of different character classes required in a password (lowercase, uppercase, digits, special characters).", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "returns_enabled", "description": "Indicates whether RMA is enabled on the storefront. Possible values: enabled/disabled", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "root_category_id", "description": "The ID of the root category", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `root_category_uid` instead" }, { "name": "root_category_uid", "description": "The unique ID for a `CategoryInterface` object.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sales_fixed_product_tax_display_setting", "description": "Corresponds to the 'Display Prices In Sales Modules' field. It indicates how FPT information is displayed on cart, checkout, and order pages", "args": [], "type": { "kind": "ENUM", "name": "FixedProductTaxDisplaySettings", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sales_gift_wrapping", "description": "Display Gift Wrapping Prices", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sales_printed_card", "description": "Display Printed Card Prices", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "secure_base_link_url", "description": "Secure base link URL for the store", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "secure_base_media_url", "description": "Secure base media URL for the store", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "secure_base_static_url", "description": "Secure base static URL for the store", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "secure_base_url", "description": "Secure base URL for the store", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "send_friend", "description": "Email to a Friend configuration.", "args": [], "type": { "kind": "OBJECT", "name": "SendFriendConfiguration", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "show_cms_breadcrumbs", "description": "Show Breadcrumbs for CMS Pages", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "store_code", "description": "The unique ID of the store view. In the Admin, this is called the Store View Code. When making a GraphQL call, assign this value to the `Store` header to provide the scope", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "store_group_code", "description": "The unique ID assigned to the store group. In the Admin, this is called the Store Name", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "store_group_name", "description": "The label assigned to the store group", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "store_name", "description": "The label assigned to the store view", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "store_sort_order", "description": "The store view sort order", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "timezone", "description": "Timezone of the store", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "title_prefix", "description": "Page Title Prefix", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "title_separator", "description": "Page Title Separator.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "title_suffix", "description": "Page Title Suffix", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "use_store_in_url", "description": "The configuration determines if the store code should be used in the URL", "args": [], "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "website_code", "description": "The unique ID for the website", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "website_id", "description": "The ID number assigned to the website store", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront" }, { "name": "website_name", "description": "The label assigned to the website", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "weight_unit", "description": "The unit of weight", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "welcome", "description": "Welcome Text", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "SCALAR", "name": "String", "description": "The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "FixedProductTaxDisplaySettings", "description": "This enumeration display settings for the fixed product tax", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "INCLUDE_FPT_WITHOUT_DETAILS", "description": "The displayed price includes the FPT amount without displaying the ProductPrice.fixed_product_taxes values. This value corresponds to 'Including FPT only'", "isDeprecated": false, "deprecationReason": "" }, { "name": "INCLUDE_FPT_WITH_DETAILS", "description": "The displayed price includes the FPT amount while displaying the values of ProductPrice.fixed_product_taxes separately. This value corresponds to 'Including FPT and FPT description'", "isDeprecated": false, "deprecationReason": "" }, { "name": "EXCLUDE_FPT_AND_INCLUDE_WITH_DETAILS", "description": "The displayed price does not include the FPT amount. The values of ProductPrice.fixed_product_taxes and the price including the FPT are displayed separately. This value corresponds to 'Excluding FPT, Including FPT description and final price'", "isDeprecated": false, "deprecationReason": "" }, { "name": "EXCLUDE_FPT_WITHOUT_DETAILS", "description": "The displayed price does not include the FPT amount. The values from ProductPrice.fixed_product_taxes are not displayed. This value corresponds to 'Excluding FPT'", "isDeprecated": false, "deprecationReason": "" }, { "name": "FPT_DISABLED", "description": "The FPT feature is not enabled. You can omit ProductPrice.fixed_product_taxes from your query", "isDeprecated": false, "deprecationReason": "" } ], "possibleTypes": null }, { "kind": "SCALAR", "name": "Int", "description": "The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1. ", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "SCALAR", "name": "ID", "description": "The `ID` scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `\"4\"`) or integer (such as `4`) input value will be accepted as an ID.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SendFriendConfiguration", "description": "", "fields": [ { "name": "enabled_for_customers", "description": "Indicates whether the Email to a Friend feature is enabled.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "enabled_for_guests", "description": "Indicates whether the Email to a Friend feature is enabled for guests.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "Cart", "description": "", "fields": [ { "name": "applied_coupon", "description": "An array of coupons that have been applied to the cart", "args": [], "type": { "kind": "OBJECT", "name": "AppliedCoupon", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use applied_coupons instead" }, { "name": "applied_coupons", "description": "An array of `AppliedCoupon` objects. Each object contains the `code` text attribute, which specifies the coupon code", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "AppliedCoupon", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "applied_gift_cards", "description": "Contains the code attribute, which specifies the applied gift card codes", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "AppliedGiftCard", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "applied_reward_points", "description": "The amount of reward points applied to the cart", "args": [], "type": { "kind": "OBJECT", "name": "RewardPointsAmount", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "applied_store_credit", "description": "Contains store credit information applied on the cart", "args": [], "type": { "kind": "OBJECT", "name": "AppliedStoreCredit", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "available_gift_wrappings", "description": "The list of available gift wrapping options for the cart", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "GiftWrapping", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "available_payment_methods", "description": "Available payment methods", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "AvailablePaymentMethod", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "billing_address", "description": null, "args": [], "type": { "kind": "OBJECT", "name": "BillingCartAddress", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "email", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "gift_message", "description": "The entered gift message for the cart", "args": [], "type": { "kind": "OBJECT", "name": "GiftMessage", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "gift_receipt_included", "description": "Wether customer requested gift receipt for the cart", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "gift_wrapping", "description": "The selected gift wrapping for the cart", "args": [], "type": { "kind": "OBJECT", "name": "GiftWrapping", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The unique ID for a `Cart` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "is_virtual", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "items", "description": null, "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "CartItemInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "prices", "description": null, "args": [], "type": { "kind": "OBJECT", "name": "CartPrices", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "printed_card_included", "description": "Wether customer requested printed card for the cart", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "selected_payment_method", "description": null, "args": [], "type": { "kind": "OBJECT", "name": "SelectedPaymentMethod", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "shipping_addresses", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "ShippingCartAddress", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "total_quantity", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AppliedCoupon", "description": "", "fields": [ { "name": "code", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AppliedGiftCard", "description": "Contains the applied gift card with applied and remaining balance", "fields": [ { "name": "applied_balance", "description": "Applied balance to the current cart", "args": [], "type": { "kind": "OBJECT", "name": "Money", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "code", "description": "Gift card account code", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "current_balance", "description": "Current balance remaining on gift card", "args": [], "type": { "kind": "OBJECT", "name": "Money", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "expiration_date", "description": "Gift card expiration date", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "Money", "description": "A Money object defines a monetary value, including a numeric value and a currency code.", "fields": [ { "name": "currency", "description": "A three-letter currency code, such as USD or EUR", "args": [], "type": { "kind": "ENUM", "name": "CurrencyEnum", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "A number expressing a monetary value", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CurrencyEnum", "description": "The list of available currency codes", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "AFN", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "ALL", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "AZN", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "DZD", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "AOA", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "ARS", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "AMD", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "AWG", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "AUD", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "BSD", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "BHD", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "BDT", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "BBD", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "BYN", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "BZD", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "BMD", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "BTN", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "BOB", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "BAM", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "BWP", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "BRL", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "GBP", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "BND", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "BGN", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "BUK", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "BIF", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "KHR", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "CAD", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "CVE", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "CZK", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "KYD", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "GQE", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "CLP", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "CNY", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "COP", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "KMF", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "CDF", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "CRC", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "HRK", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "CUP", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "DKK", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "DJF", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "DOP", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "XCD", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "EGP", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "SVC", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "ERN", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "EEK", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "ETB", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "EUR", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "FKP", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "FJD", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "GMD", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "GEK", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "GEL", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "GHS", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "GIP", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "GTQ", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "GNF", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "GYD", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "HTG", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "HNL", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "HKD", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "HUF", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "ISK", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "INR", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "IDR", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "IRR", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "IQD", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "ILS", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "JMD", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "JPY", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "JOD", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "KZT", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "KES", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "KWD", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "KGS", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "LAK", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "LVL", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "LBP", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "LSL", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "LRD", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "LYD", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "LTL", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "MOP", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "MKD", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "MGA", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "MWK", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "MYR", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "MVR", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "LSM", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "MRO", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "MUR", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "MXN", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "MDL", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "MNT", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "MAD", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "MZN", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "MMK", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "NAD", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "NPR", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "ANG", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "YTL", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "NZD", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "NIC", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "NGN", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "KPW", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "NOK", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "OMR", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "PKR", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "PAB", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "PGK", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "PYG", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "PEN", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "PHP", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "PLN", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "QAR", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "RHD", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "RON", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "RUB", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "RWF", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "SHP", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "STD", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "SAR", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "RSD", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "SCR", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "SLL", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "SGD", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "SKK", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "SBD", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "SOS", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "ZAR", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "KRW", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "LKR", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "SDG", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "SRD", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "SZL", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "SEK", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "CHF", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "SYP", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "TWD", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "TJS", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "TZS", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "THB", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "TOP", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "TTD", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "TND", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "TMM", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "USD", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "UGX", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "UAH", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "AED", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "UYU", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "UZS", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "VUV", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "VEB", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "VEF", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "VND", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "CHE", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "CHW", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "XOF", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "WST", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "YER", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "ZMK", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "ZWD", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "TRY", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "AZM", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "ROL", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "TRL", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "XPF", "description": "", "isDeprecated": false, "deprecationReason": "" } ], "possibleTypes": null }, { "kind": "SCALAR", "name": "Float", "description": "The `Float` scalar type represents signed double-precision fractional values as specified by [IEEE 754](https://en.wikipedia.org/wiki/IEEE_floating_point). ", "fields": null, "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "RewardPointsAmount", "description": "", "fields": [ { "name": "money", "description": "Reward points amount in store currency", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "points", "description": "Reward points amount in points", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AppliedStoreCredit", "description": "Applied and current balance", "fields": [ { "name": "applied_balance", "description": "Applied store credit balance to the current cart", "args": [], "type": { "kind": "OBJECT", "name": "Money", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "current_balance", "description": "Current balance remaining on store credit", "args": [], "type": { "kind": "OBJECT", "name": "Money", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "enabled", "description": "Indicates whether store credits are enabled. If the feature is disabled, then the current balance will not be returned", "args": [], "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "GiftWrapping", "description": "", "fields": [ { "name": "design", "description": "Gift wrapping design name", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The unique ID for a `GiftWrapping` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `uid` instead" }, { "name": "image", "description": "Gift wrapping preview image", "args": [], "type": { "kind": "OBJECT", "name": "GiftWrappingImage", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "price", "description": "Gift wrapping price", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "uid", "description": "The unique ID for a `GiftWrapping` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "GiftWrappingImage", "description": "", "fields": [ { "name": "label", "description": "Gift wrapping preview image label", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "url", "description": "Gift wrapping preview image URL", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AvailablePaymentMethod", "description": "", "fields": [ { "name": "code", "description": "The payment method code", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The payment method title.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "BillingCartAddress", "description": "", "fields": [ { "name": "city", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "company", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "country", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CartAddressCountry", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customer_notes", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field is used only in shipping address" }, { "name": "firstname", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lastname", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "postcode", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "region", "description": null, "args": [], "type": { "kind": "OBJECT", "name": "CartAddressRegion", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "street", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "telephone", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "CartAddressInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "INTERFACE", "name": "CartAddressInterface", "description": "", "fields": [ { "name": "city", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "company", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "country", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CartAddressCountry", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "firstname", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lastname", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "postcode", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "region", "description": null, "args": [], "type": { "kind": "OBJECT", "name": "CartAddressRegion", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "street", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "telephone", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "BillingCartAddress", "ofType": null }, { "kind": "OBJECT", "name": "ShippingCartAddress", "ofType": null } ] }, { "kind": "OBJECT", "name": "CartAddressCountry", "description": "", "fields": [ { "name": "code", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "label", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CartAddressRegion", "description": "", "fields": [ { "name": "code", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "label", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "region_id", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "GiftMessage", "description": "Contains the text of a gift message, its sender, and recipient", "fields": [ { "name": "from", "description": "Sender name", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "Gift message text", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "to", "description": "Recipient name", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INTERFACE", "name": "CartItemInterface", "description": "", "fields": [ { "name": "id", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `uid` instead" }, { "name": "prices", "description": null, "args": [], "type": { "kind": "OBJECT", "name": "CartItemPrices", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INTERFACE", "name": "ProductInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "uid", "description": "The unique ID for a `CartItemInterface` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "SimpleCartItem", "ofType": null }, { "kind": "OBJECT", "name": "VirtualCartItem", "ofType": null }, { "kind": "OBJECT", "name": "DownloadableCartItem", "ofType": null }, { "kind": "OBJECT", "name": "ConfigurableCartItem", "ofType": null }, { "kind": "OBJECT", "name": "BundleCartItem", "ofType": null }, { "kind": "OBJECT", "name": "GiftCardCartItem", "ofType": null } ] }, { "kind": "OBJECT", "name": "CartItemPrices", "description": "", "fields": [ { "name": "discounts", "description": "An array of discounts to be applied to the cart item", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "Discount", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "price", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "row_total", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "row_total_including_tax", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "total_item_discount", "description": "The total of all discounts applied to the item", "args": [], "type": { "kind": "OBJECT", "name": "Money", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "Discount", "description": "Defines an individual discount. A discount can be applied to the cart as a whole or to an item.", "fields": [ { "name": "amount", "description": "The amount of the discount", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "label", "description": "A description of the discount", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INTERFACE", "name": "ProductInterface", "description": "The ProductInterface contains attributes that are common to all types of products. Note that descriptions may not be available for custom and EAV attributes.", "fields": [ { "name": "attribute_set_id", "description": "The attribute set assigned to the product.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "canonical_url", "description": "Relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "categories", "description": "The categories assigned to a product.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "CategoryInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "color", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "country_of_manufacture", "description": "The product's country of origin.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "created_at", "description": "Timestamp indicating when the product was created.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "crosssell_products", "description": "Crosssell Products", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "ProductInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": "Detailed information about the product. The value can include simple HTML tags.", "args": [], "type": { "kind": "OBJECT", "name": "ComplexTextValue", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fashion_color", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fashion_material", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fashion_size", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fashion_style", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "format", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "gift_message_available", "description": "Indicates whether a gift message is available.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "has_video", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The ID number assigned to the product.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use the `uid` field instead." }, { "name": "image", "description": "The relative path to the main image on the product page.", "args": [], "type": { "kind": "OBJECT", "name": "ProductImage", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "is_returnable", "description": "Indicates whether the product can be returned", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "manufacturer", "description": "A number representing the product's manufacturer.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "media_gallery", "description": "An array of Media Gallery objects.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "MediaGalleryInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "media_gallery_entries", "description": "An array of MediaGalleryEntry objects.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "MediaGalleryEntry", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use product's `media_gallery` instead" }, { "name": "meta_description", "description": "A brief overview of the product for search results listings, maximum 255 characters.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "meta_keyword", "description": "A comma-separated list of keywords that are visible only to search engines.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "meta_title", "description": "A string that is displayed in the title bar and tab of the browser and in search results lists.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The product name. Customers use this name to identify the product.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "new_from_date", "description": "The beginning date for new product listings, and determines if the product is featured as a new product.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "new_to_date", "description": "The end date for new product listings.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "only_x_left_in_stock", "description": "Product stock only x left count", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "options_container", "description": "If the product has multiple options, determines where they appear on the product page.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "price", "description": "A ProductPrices object, indicating the price of an item.", "args": [], "type": { "kind": "OBJECT", "name": "ProductPrices", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use price_range for product price information." }, { "name": "price_range", "description": "A PriceRange object, indicating the range of prices for the product", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PriceRange", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "price_tiers", "description": "An array of TierPrice objects.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "TierPrice", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_links", "description": "An array of ProductLinks objects.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "ProductLinksInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "rating_summary", "description": "The average of all the ratings given to the product.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "related_products", "description": "Related Products", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "ProductInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "review_count", "description": "The total count of all the reviews given to the product.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "reviews", "description": "The list of products reviews.", "args": [ { "name": "pageSize", "description": "Specifies the maximum number of results to return at once.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": "20" }, { "name": "currentPage", "description": "Specifies which page of results to return.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": "1" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductReviews", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "short_description", "description": "A short description of the product. Its use depends on the theme.", "args": [], "type": { "kind": "OBJECT", "name": "ComplexTextValue", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sku", "description": "A number or code assigned to a product to identify the product, options, price, and manufacturer.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "small_image", "description": "The relative path to the small image, which is used on catalog pages.", "args": [], "type": { "kind": "OBJECT", "name": "ProductImage", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "special_from_date", "description": "The beginning date that a product has a special price.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "special_price", "description": "The discounted price of the product.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "special_to_date", "description": "The end date that a product has a special price.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "staged", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "stock_status", "description": "Stock status of the product", "args": [], "type": { "kind": "ENUM", "name": "ProductStockStatus", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "swatch_image", "description": "The file name of a swatch image", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "thumbnail", "description": "The relative path to the product's thumbnail image.", "args": [], "type": { "kind": "OBJECT", "name": "ProductImage", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "tier_price", "description": "The price when tier pricing is in effect and the items purchased threshold has been reached.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use price_tiers for product tier price information." }, { "name": "tier_prices", "description": "An array of ProductTierPrices objects.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductTierPrices", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use price_tiers for product tier price information." }, { "name": "type_id", "description": "One of simple, virtual, bundle, downloadable, grouped, or configurable.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use __typename instead." }, { "name": "uid", "description": "The unique ID for a `ProductInterface` object.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "updated_at", "description": "Timestamp indicating when the product was updated.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "upsell_products", "description": "Upsell Products", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "ProductInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "url_key", "description": "The part of the URL that identifies the product", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "url_path", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use product's `canonical_url` or url rewrites instead" }, { "name": "url_rewrites", "description": "URL rewrites list", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "UrlRewrite", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "url_suffix", "description": "The part of the product URL that is appended after the url key", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "video_file", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "websites", "description": "An array of websites in which the product is available.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "Website", "ofType": null } }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." } ], "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "VirtualProduct", "ofType": null }, { "kind": "OBJECT", "name": "SimpleProduct", "ofType": null }, { "kind": "OBJECT", "name": "DownloadableProduct", "ofType": null }, { "kind": "OBJECT", "name": "BundleProduct", "ofType": null }, { "kind": "OBJECT", "name": "GroupedProduct", "ofType": null }, { "kind": "OBJECT", "name": "ConfigurableProduct", "ofType": null }, { "kind": "OBJECT", "name": "GiftCardProduct", "ofType": null } ] }, { "kind": "INTERFACE", "name": "CategoryInterface", "description": "CategoryInterface contains the full set of attributes that can be returned in a category search.", "fields": [ { "name": "automatic_sorting", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "available_sort_by", "description": null, "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "breadcrumbs", "description": "Breadcrumbs, parent categories info.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "Breadcrumb", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "canonical_url", "description": "Relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Categories' is enabled", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "children_count", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "cms_block", "description": "Category CMS Block.", "args": [], "type": { "kind": "OBJECT", "name": "CmsBlock", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "created_at", "description": "Timestamp indicating when the category was created.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "custom_layout_update_file", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "default_sort_by", "description": "The attribute to use for sorting.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": "An optional description of the category.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "display_mode", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "filter_price_range", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "An ID that uniquely identifies the category.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use the `uid` argument instead." }, { "name": "image", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "include_in_menu", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "is_anchor", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "landing_page", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "level", "description": "Indicates the depth of the category within the tree.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "meta_description", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "meta_keywords", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "meta_title", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The display name of the category.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "path", "description": "Category Path.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "path_in_store", "description": "Category path in store.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "position", "description": "The position of the category relative to other categories at the same level in tree.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_count", "description": "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.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "products", "description": "The list of products assigned to the category.", "args": [ { "name": "pageSize", "description": "Specifies the maximum number of results to return at once. This attribute is optional.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": "20" }, { "name": "currentPage", "description": "Specifies which page of results to return. The default value is 1.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": "1" }, { "name": "sort", "description": "Specifies which attributes to sort on, and whether to return the results in ascending or descending order.", "type": { "kind": "INPUT_OBJECT", "name": "ProductAttributeSortInput", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CategoryProducts", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "staged", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "uid", "description": "The unique ID for a `CategoryInterface` object.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "updated_at", "description": "Timestamp indicating when the category was updated.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "url_key", "description": "The url key assigned to the category.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "url_path", "description": "The url path assigned to the category.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "url_suffix", "description": "The part of the category URL that is appended after the url key", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "CategoryTree", "ofType": null } ] }, { "kind": "OBJECT", "name": "Breadcrumb", "description": "Breadcrumb item.", "fields": [ { "name": "category_id", "description": "Category ID.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use the `category_uid` argument instead." }, { "name": "category_level", "description": "Category level.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "category_name", "description": "Category name.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "category_uid", "description": "The unique ID for a `Breadcrumb` object.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "category_url_key", "description": "Category URL key.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "category_url_path", "description": "Category URL path.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CmsBlock", "description": "CMS block defines all CMS block information", "fields": [ { "name": "content", "description": "CMS block content", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "identifier", "description": "CMS block identifier", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "CMS block title", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ProductAttributeSortInput", "description": "ProductAttributeSortInput specifies the attribute to use for sorting search results and indicates whether the results are sorted in ascending or descending order. It's possible to sort products using searchable attributes with enabled 'Use in Filter Options' option", "fields": null, "inputFields": [ { "name": "name", "description": "Attribute label: Product Name", "type": { "kind": "ENUM", "name": "SortEnum", "ofType": null }, "defaultValue": null }, { "name": "position", "description": "Sort by the position assigned to each product.", "type": { "kind": "ENUM", "name": "SortEnum", "ofType": null }, "defaultValue": null }, { "name": "price", "description": "Attribute label: Price", "type": { "kind": "ENUM", "name": "SortEnum", "ofType": null }, "defaultValue": null }, { "name": "relevance", "description": "Sort by the search relevance score (default).", "type": { "kind": "ENUM", "name": "SortEnum", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "SortEnum", "description": "This enumeration indicates whether to return results in ascending or descending order", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "ASC", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "DESC", "description": "", "isDeprecated": false, "deprecationReason": "" } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "CategoryProducts", "description": "The category products object returned in the Category query.", "fields": [ { "name": "items", "description": "An array of products that are assigned to the category.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "ProductInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "page_info", "description": "An object that includes the page_info and currentPage values specified in the query.", "args": [], "type": { "kind": "OBJECT", "name": "SearchResultPageInfo", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "total_count", "description": "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.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SearchResultPageInfo", "description": "SearchResultPageInfo provides navigation for the query response", "fields": [ { "name": "current_page", "description": "Specifies which page of results to return", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "page_size", "description": "Specifies the maximum number of items to return", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "total_pages", "description": "Total pages", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ComplexTextValue", "description": "", "fields": [ { "name": "html", "description": "HTML format", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductImage", "description": "Product image information. Contains the image URL and label.", "fields": [ { "name": "disabled", "description": "Whether the image is hidden from view.", "args": [], "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "label", "description": "The label of the product image or video.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "position", "description": "The media item's position after it has been sorted.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "url", "description": "The URL of the product image or video.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "MediaGalleryInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "INTERFACE", "name": "MediaGalleryInterface", "description": "Contains basic information about a product image or video.", "fields": [ { "name": "disabled", "description": "Whether the image is hidden from view.", "args": [], "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "label", "description": "The label of the product image or video.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "position", "description": "The media item's position after it has been sorted.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "url", "description": "The URL of the product image or video.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "ProductImage", "ofType": null }, { "kind": "OBJECT", "name": "ProductVideo", "ofType": null } ] }, { "kind": "OBJECT", "name": "MediaGalleryEntry", "description": "MediaGalleryEntry defines characteristics about images and videos associated with a specific product.", "fields": [ { "name": "content", "description": "Contains a ProductMediaGalleryEntriesContent object.", "args": [], "type": { "kind": "OBJECT", "name": "ProductMediaGalleryEntriesContent", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "disabled", "description": "Whether the image is hidden from view.", "args": [], "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "file", "description": "The path of the image on the server.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The identifier assigned to the object.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `uid` instead." }, { "name": "label", "description": "The alt text displayed on the UI when the user points to the image.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "media_type", "description": "image or video.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "position", "description": "The media item's position after it has been sorted.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "types", "description": "Array of image types. It can have the following values: image, small_image, thumbnail.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "uid", "description": "The unique ID for a `MediaGalleryEntry` object.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "video_content", "description": "Contains a ProductMediaGalleryEntriesVideoContent object.", "args": [], "type": { "kind": "OBJECT", "name": "ProductMediaGalleryEntriesVideoContent", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductMediaGalleryEntriesContent", "description": "ProductMediaGalleryEntriesContent contains an image in base64 format and basic information about the image.", "fields": [ { "name": "base64_encoded_data", "description": "The image in base64 format.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The file name of the image.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "type", "description": "The MIME type of the file, such as image/png.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductMediaGalleryEntriesVideoContent", "description": "ProductMediaGalleryEntriesVideoContent contains a link to a video file and basic information about the video.", "fields": [ { "name": "media_type", "description": "Must be external-video.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "video_description", "description": "A description of the video.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "video_metadata", "description": "Optional data about the video.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "video_provider", "description": "Describes the video source.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "video_title", "description": "The title of the video.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "video_url", "description": "The URL to the video.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductPrices", "description": "ProductPrices is deprecated, replaced by PriceRange. The ProductPrices object contains the regular price of an item, as well as its minimum and maximum prices. Only composite products, which include bundle, configurable, and grouped products, can contain a minimum and maximum price.", "fields": [ { "name": "maximalPrice", "description": "The highest possible final price for all the options defined within a composite product. If you are specifying a price range, this would be the to value.", "args": [], "type": { "kind": "OBJECT", "name": "Price", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use PriceRange.maximum_price." }, { "name": "minimalPrice", "description": "The lowest possible final price for all the options defined within a composite product. If you are specifying a price range, this would be the from value.", "args": [], "type": { "kind": "OBJECT", "name": "Price", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use PriceRange.minimum_price." }, { "name": "regularPrice", "description": "The base price of a product.", "args": [], "type": { "kind": "OBJECT", "name": "Price", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use regular_price from PriceRange.minimum_price or PriceRange.maximum_price." } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "Price", "description": "Price is deprecated, replaced by ProductPrice. The Price object defines the price of a product as well as any tax-related adjustments.", "fields": [ { "name": "adjustments", "description": "An array that provides information about tax, weee, or weee_tax adjustments.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "PriceAdjustment", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Price is deprecated, use ProductPrice." }, { "name": "amount", "description": "The price of a product plus a three-letter currency code.", "args": [], "type": { "kind": "OBJECT", "name": "Money", "ofType": null }, "isDeprecated": true, "deprecationReason": "Price is deprecated, use ProductPrice." } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PriceAdjustment", "description": "PriceAdjustment is deprecated. Taxes will be included or excluded in the price. The PricedAdjustment object defines the amount of money to apply as an adjustment, the type of adjustment to apply, and whether the item is included or excluded from the adjustment.", "fields": [ { "name": "amount", "description": "The amount of the price adjustment and its currency code.", "args": [], "type": { "kind": "OBJECT", "name": "Money", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "code", "description": "Indicates whether the adjustment involves tax, weee, or weee_tax.", "args": [], "type": { "kind": "ENUM", "name": "PriceAdjustmentCodesEnum", "ofType": null }, "isDeprecated": true, "deprecationReason": "PriceAdjustment is deprecated." }, { "name": "description", "description": "Indicates whether the entity described by the code attribute is included or excluded from the adjustment.", "args": [], "type": { "kind": "ENUM", "name": "PriceAdjustmentDescriptionEnum", "ofType": null }, "isDeprecated": true, "deprecationReason": "PriceAdjustment is deprecated." } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "PriceAdjustmentCodesEnum", "description": "PriceAdjustment.code is deprecated. This enumeration contains values defined in modules other than the Catalog module.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "TAX", "description": "", "isDeprecated": true, "deprecationReason": "PriceAdjustmentCodesEnum is deprecated. Tax is included or excluded in price. Tax is not shown separtely in Catalog" }, { "name": "WEEE", "description": "", "isDeprecated": true, "deprecationReason": "WEEE code is deprecated, use fixed_product_taxes.label" }, { "name": "WEEE_TAX", "description": "", "isDeprecated": true, "deprecationReason": "Use fixed_product_taxes. PriceAdjustmentCodesEnum is deprecated. Tax is included or excluded in price. Tax is not shown separtely in Catalog" } ], "possibleTypes": null }, { "kind": "ENUM", "name": "PriceAdjustmentDescriptionEnum", "description": "PriceAdjustmentDescriptionEnum is deprecated. This enumeration states whether a price adjustment is included or excluded.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "INCLUDED", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "EXCLUDED", "description": "", "isDeprecated": false, "deprecationReason": "" } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "PriceRange", "description": "Price range for a product. If the product has a single price, the minimum and maximum price will be the same.", "fields": [ { "name": "maximum_price", "description": "The highest possible price for the product.", "args": [], "type": { "kind": "OBJECT", "name": "ProductPrice", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "minimum_price", "description": "The lowest possible price for the product.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductPrice", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductPrice", "description": "Represents a product price.", "fields": [ { "name": "discount", "description": "The price discount. Represents the difference between the regular and final price.", "args": [], "type": { "kind": "OBJECT", "name": "ProductDiscount", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "final_price", "description": "The final price of the product after discounts applied.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "fixed_product_taxes", "description": "The multiple FPTs that can be applied to a product price.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "FixedProductTax", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "regular_price", "description": "The regular price of the product.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductDiscount", "description": "A discount applied to a product price.", "fields": [ { "name": "amount_off", "description": "The actual value of the discount.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "percent_off", "description": "The discount expressed a percentage.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "FixedProductTax", "description": "A single FPT that can be applied to a product price.", "fields": [ { "name": "amount", "description": "Amount of the FPT as a money object.", "args": [], "type": { "kind": "OBJECT", "name": "Money", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "label", "description": "The label assigned to the FPT to be displayed on the frontend.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "TierPrice", "description": "A price based on the quantity purchased.", "fields": [ { "name": "discount", "description": "The price discount that this tier represents.", "args": [], "type": { "kind": "OBJECT", "name": "ProductDiscount", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "final_price", "description": null, "args": [], "type": { "kind": "OBJECT", "name": "Money", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity", "description": "The minimum number of items that must be purchased to qualify for this price tier.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INTERFACE", "name": "ProductLinksInterface", "description": "ProductLinks contains information about linked products, including the link type and product type of each item.", "fields": [ { "name": "link_type", "description": "One of related, associated, upsell, or crosssell.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "linked_product_sku", "description": "The SKU of the linked product.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "linked_product_type", "description": "The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable).", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "position", "description": "The position within the list of product links.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sku", "description": "The identifier of the linked product.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "ProductLinks", "ofType": null } ] }, { "kind": "OBJECT", "name": "ProductReviews", "description": "", "fields": [ { "name": "items", "description": "An array of product reviews.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductReview", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "page_info", "description": "Metadata for pagination rendering.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "SearchResultPageInfo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductReview", "description": "Details of a product review", "fields": [ { "name": "average_rating", "description": "The average rating for product review.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "created_at", "description": "Date indicating when the review was created.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "nickname", "description": "The customer's nickname. Defaults to the customer name, if logged in", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product", "description": "Contains details about the reviewed product", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INTERFACE", "name": "ProductInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "ratings_breakdown", "description": "An array of ratings by rating category, such as quality, price, and value", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductReviewRating", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "summary", "description": "The summary (title) of the review", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "text", "description": "The review text.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductReviewRating", "description": "", "fields": [ { "name": "name", "description": "The label assigned to an aspect of a product that is being rated, such as quality or price", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "The rating value given by customer. By default, possible values range from 1 to 5.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ProductStockStatus", "description": "This enumeration states whether a product stock status is in stock or out of stock", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "IN_STOCK", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "OUT_OF_STOCK", "description": "", "isDeprecated": false, "deprecationReason": "" } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductTierPrices", "description": "ProductTierPrices is deprecated and has been replaced by TierPrice. The ProductTierPrices object defines a tier price, which is a quantity discount offered to a specific customer group.", "fields": [ { "name": "customer_group_id", "description": "The ID of the customer group.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "customer_group_id is not relevant for storefront." }, { "name": "percentage_value", "description": "The percentage discount of the item.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": true, "deprecationReason": "ProductTierPrices is deprecated. Use TierPrice.discount." }, { "name": "qty", "description": "The number of items that must be purchased to qualify for tier pricing.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": true, "deprecationReason": "ProductTierPrices is deprecated, use TierPrice.quantity." }, { "name": "value", "description": "The price of the fixed price item.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": true, "deprecationReason": "ProductTierPrices is deprecated. Use TierPrice.final_price" }, { "name": "website_id", "description": "The ID assigned to the website.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": true, "deprecationReason": "website_id is not relevant for storefront." } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "UrlRewrite", "description": "The object contains URL rewrite details", "fields": [ { "name": "parameters", "description": "Request parameters", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "HttpQueryParameter", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "url", "description": "Request URL", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "HttpQueryParameter", "description": "The object details of target path parameters", "fields": [ { "name": "name", "description": "Parameter name", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "Parameter value", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "Website", "description": "Website is deprecated because it is should not be used on storefront. The type contains information about a website", "fields": [ { "name": "code", "description": "A code assigned to the website to identify it", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "default_group_id", "description": "The default group ID that the website has", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "id", "description": "The ID number assigned to the website", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "is_default", "description": "Specifies if this is the default website", "args": [], "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "name", "description": "The website name. Websites use this name to identify it easier.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "sort_order", "description": "The attribute to use for sorting websites", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CartPrices", "description": "", "fields": [ { "name": "applied_taxes", "description": null, "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "CartTaxItem", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discount", "description": null, "args": [], "type": { "kind": "OBJECT", "name": "CartDiscount", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use discounts instead " }, { "name": "discounts", "description": "An array of applied discounts", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "Discount", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "gift_options", "description": "The list of prices for the selected gift options", "args": [], "type": { "kind": "OBJECT", "name": "GiftOptionsPrices", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "grand_total", "description": null, "args": [], "type": { "kind": "OBJECT", "name": "Money", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "subtotal_excluding_tax", "description": null, "args": [], "type": { "kind": "OBJECT", "name": "Money", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "subtotal_including_tax", "description": null, "args": [], "type": { "kind": "OBJECT", "name": "Money", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "subtotal_with_discount_excluding_tax", "description": null, "args": [], "type": { "kind": "OBJECT", "name": "Money", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CartTaxItem", "description": "", "fields": [ { "name": "amount", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "label", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CartDiscount", "description": "", "fields": [ { "name": "amount", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "label", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "GiftOptionsPrices", "description": "", "fields": [ { "name": "gift_wrapping_for_items", "description": "Price of the gift wrapping for all individual order items", "args": [], "type": { "kind": "OBJECT", "name": "Money", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "gift_wrapping_for_order", "description": "Price of the gift wrapping for the whole order", "args": [], "type": { "kind": "OBJECT", "name": "Money", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "printed_card", "description": "Price for the printed card", "args": [], "type": { "kind": "OBJECT", "name": "Money", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SelectedPaymentMethod", "description": "", "fields": [ { "name": "code", "description": "The payment method code", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "purchase_order_number", "description": "The purchase order number.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The payment method title.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ShippingCartAddress", "description": "", "fields": [ { "name": "available_shipping_methods", "description": null, "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "AvailableShippingMethod", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "cart_items", "description": null, "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "CartItemQuantity", "ofType": null } }, "isDeprecated": true, "deprecationReason": "`cart_items_v2` should be used instead" }, { "name": "cart_items_v2", "description": null, "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "CartItemInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "city", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "company", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "country", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CartAddressCountry", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customer_notes", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "firstname", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "items_weight", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": true, "deprecationReason": "This information shoud not be exposed on frontend" }, { "name": "lastname", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "pickup_location_code", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "postcode", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "region", "description": null, "args": [], "type": { "kind": "OBJECT", "name": "CartAddressRegion", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "selected_shipping_method", "description": null, "args": [], "type": { "kind": "OBJECT", "name": "SelectedShippingMethod", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "street", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "telephone", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "CartAddressInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AvailableShippingMethod", "description": "", "fields": [ { "name": "amount", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "available", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "base_amount", "description": null, "args": [], "type": { "kind": "OBJECT", "name": "Money", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront" }, { "name": "carrier_code", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "carrier_title", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "error_message", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "method_code", "description": "Could be null if method is not available", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "method_title", "description": "Could be null if method is not available", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "price_excl_tax", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "price_incl_tax", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CartItemQuantity", "description": "Deprecated: `cart_items` field of `ShippingCartAddress` returns now `CartItemInterface` instead of `CartItemQuantity`", "fields": [ { "name": "cart_item_id", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": true, "deprecationReason": "`cart_items` field of `ShippingCartAddress` returns now `CartItemInterface` instead of `CartItemQuantity`" }, { "name": "quantity", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": true, "deprecationReason": "`cart_items` field of `ShippingCartAddress` returns now `CartItemInterface` instead of `CartItemQuantity`" } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SelectedShippingMethod", "description": "", "fields": [ { "name": "amount", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "base_amount", "description": null, "args": [], "type": { "kind": "OBJECT", "name": "Money", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront" }, { "name": "carrier_code", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "carrier_title", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "method_code", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "method_title", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CategoryFilterInput", "description": "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.", "fields": null, "inputFields": [ { "name": "category_uid", "description": "Filter by the unique category ID for a `CategoryInterface` object.", "type": { "kind": "INPUT_OBJECT", "name": "FilterEqualTypeInput", "ofType": null }, "defaultValue": null }, { "name": "ids", "description": "Deprecated: use 'category_uid' to filter uniquely identifiers of categories.", "type": { "kind": "INPUT_OBJECT", "name": "FilterEqualTypeInput", "ofType": null }, "defaultValue": null }, { "name": "name", "description": "Filter by the display name of the category.", "type": { "kind": "INPUT_OBJECT", "name": "FilterMatchTypeInput", "ofType": null }, "defaultValue": null }, { "name": "parent_category_uid", "description": "Filter by the unique parent category ID for a `CategoryInterface` object.", "type": { "kind": "INPUT_OBJECT", "name": "FilterEqualTypeInput", "ofType": null }, "defaultValue": null }, { "name": "parent_id", "description": "Filter by the unique parent category ID for a `CategoryInterface` object.", "type": { "kind": "INPUT_OBJECT", "name": "FilterEqualTypeInput", "ofType": null }, "defaultValue": null }, { "name": "url_key", "description": "Filter by the part of the URL that identifies the category.", "type": { "kind": "INPUT_OBJECT", "name": "FilterEqualTypeInput", "ofType": null }, "defaultValue": null }, { "name": "url_path", "description": "Filter by the URL path for the category.", "type": { "kind": "INPUT_OBJECT", "name": "FilterEqualTypeInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "FilterEqualTypeInput", "description": "Defines a filter that matches the input exactly.", "fields": null, "inputFields": [ { "name": "eq", "description": "A string to filter on", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "in", "description": "An array of values to filter on", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "FilterMatchTypeInput", "description": "Defines a filter that performs a fuzzy search.", "fields": null, "inputFields": [ { "name": "match", "description": "One or more words to filter on", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CategoryResult", "description": "A collection of CategoryTree objects and pagination information.", "fields": [ { "name": "items", "description": "A list of categories that match the filter criteria.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "CategoryTree", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "page_info", "description": "An object that includes the page_info and currentPage values specified in the query.", "args": [], "type": { "kind": "OBJECT", "name": "SearchResultPageInfo", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "total_count", "description": "The total number of categories that match the criteria.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CategoryTree", "description": "Category Tree implementation.", "fields": [ { "name": "automatic_sorting", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "available_sort_by", "description": null, "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "breadcrumbs", "description": "Breadcrumbs, parent categories info.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "Breadcrumb", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "canonical_url", "description": "Relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Categories' is enabled", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "children", "description": "Child categories tree.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "CategoryTree", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "children_count", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "cms_block", "description": "Category CMS Block.", "args": [], "type": { "kind": "OBJECT", "name": "CmsBlock", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "created_at", "description": "Timestamp indicating when the category was created.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "custom_layout_update_file", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "default_sort_by", "description": "The attribute to use for sorting.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": "An optional description of the category.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "display_mode", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "filter_price_range", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "An ID that uniquely identifies the category.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use the `uid` argument instead." }, { "name": "image", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "include_in_menu", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "is_anchor", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "landing_page", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "level", "description": "Indicates the depth of the category within the tree.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "meta_description", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "meta_keywords", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "meta_title", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The display name of the category.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "path", "description": "Category Path.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "path_in_store", "description": "Category path in store.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "position", "description": "The position of the category relative to other categories at the same level in tree.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_count", "description": "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.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "products", "description": "The list of products assigned to the category.", "args": [ { "name": "pageSize", "description": "Specifies the maximum number of results to return at once. This attribute is optional.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": "20" }, { "name": "currentPage", "description": "Specifies which page of results to return. The default value is 1.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": "1" }, { "name": "sort", "description": "Specifies which attributes to sort on, and whether to return the results in ascending or descending order.", "type": { "kind": "INPUT_OBJECT", "name": "ProductAttributeSortInput", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CategoryProducts", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "staged", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "uid", "description": "The unique ID for a `CategoryInterface` object.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "updated_at", "description": "Timestamp indicating when the category was updated.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "url_key", "description": "The url key assigned to the category.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "url_path", "description": "The url path assigned to the category.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "url_suffix", "description": "The part of the category URL that is appended after the url key", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "CategoryInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CheckoutAgreement", "description": "Defines all Checkout Agreement information", "fields": [ { "name": "agreement_id", "description": "Checkout Agreement identifier", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "checkbox_text", "description": "Checkout Agreement checkbox text", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "content", "description": "Checkout Agreement content", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "content_height", "description": "Checkout Agreement content height", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "is_html", "description": "Is Checkout Agreement content in HTML format", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "mode", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CheckoutAgreementMode", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "Checkout Agreement name", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CheckoutAgreementMode", "description": "", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "AUTO", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "MANUAL", "description": "", "isDeprecated": false, "deprecationReason": "" } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "CmsBlocks", "description": "CMS blocks information", "fields": [ { "name": "items", "description": "An array of CMS blocks", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "CmsBlock", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CmsPage", "description": "CMS page defines all CMS page information", "fields": [ { "name": "content", "description": "CMS page content", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "content_heading", "description": "CMS page content heading", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "identifier", "description": "Identifier of the CMS page", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "meta_description", "description": "CMS page meta description", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "meta_keywords", "description": "CMS page meta keywords", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "meta_title", "description": "CMS page meta title", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "page_layout", "description": "CMS page content heading", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "CMS page title", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "url_key", "description": "URL key of CMS page", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CompareList", "description": "", "fields": [ { "name": "attributes", "description": "An array of attributes that can be used for comparing products", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "ComparableAttribute", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "item_count", "description": "The number of items in the compare list", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "items", "description": "An array of products to compare", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "ComparableItem", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "uid", "description": "The unique ID assigned to the compare list", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ComparableAttribute", "description": "", "fields": [ { "name": "code", "description": "An attribute code that is enabled for product comparisons", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "label", "description": "The label of the attribute code", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ComparableItem", "description": "", "fields": [ { "name": "attributes", "description": "An array of product attributes that can be used to compare products", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductAttribute", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product", "description": "Contains details about a product in a compare list", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INTERFACE", "name": "ProductInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "uid", "description": "The unique ID of an item in a compare list", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductAttribute", "description": "", "fields": [ { "name": "code", "description": "The unique identifier for a product attribute code.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "The display value of the attribute", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "Country", "description": "", "fields": [ { "name": "available_regions", "description": null, "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "Region", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "full_name_english", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "full_name_locale", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The unique ID for a `Country` object.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "three_letter_abbreviation", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "two_letter_abbreviation", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "Region", "description": "", "fields": [ { "name": "code", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The unique ID for a `Region` object.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "Currency", "description": "", "fields": [ { "name": "available_currency_codes", "description": null, "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "base_currency_code", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "base_currency_symbol", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "default_display_currecy_code", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "Symbol was missed. Use `default_display_currency_code`." }, { "name": "default_display_currecy_symbol", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "Symbol was missed. Use `default_display_currency_symbol`." }, { "name": "default_display_currency_code", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "default_display_currency_symbol", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "exchange_rates", "description": null, "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "ExchangeRate", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ExchangeRate", "description": "", "fields": [ { "name": "currency_to", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "rate", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "AttributeInput", "description": "AttributeInput specifies the attribute_code and entity_type to search", "fields": null, "inputFields": [ { "name": "attribute_code", "description": "The unique identifier for an attribute code. This value should be in lowercase letters without spaces.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "entity_type", "description": "The type of entity that defines the attribute", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomAttributeMetadata", "description": "CustomAttributeMetadata defines an array of attribute_codes and entity_types", "fields": [ { "name": "items", "description": "An array of attributes", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "Attribute", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "Attribute", "description": "Attribute contains the attribute_type of the specified attribute_code and entity_type", "fields": [ { "name": "attribute_code", "description": "The unique identifier for an attribute code. This value should be in lowercase letters without spaces.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "attribute_options", "description": "Attribute options list.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "AttributeOption", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "attribute_type", "description": "The data type of the attribute", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "entity_type", "description": "The type of entity that defines the attribute", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "input_type", "description": "The frontend input type of the attribute", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AttributeOption", "description": "Attribute option.", "fields": [ { "name": "label", "description": "Attribute option label.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "Attribute option value.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "Customer", "description": "Customer defines the customer name and address and other details", "fields": [ { "name": "addresses", "description": "An array containing the customer's shipping and billing addresses", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "CustomerAddress", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "allow_remote_shopping_assistance", "description": "Indicates whether the customer has enabled remote shopping assistance", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "compare_list", "description": "The contents of the customer's compare list", "args": [], "type": { "kind": "OBJECT", "name": "CompareList", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "created_at", "description": "Timestamp indicating when the account was created", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "date_of_birth", "description": "The customer's date of birth", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "default_billing", "description": "The ID assigned to the billing address", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "default_shipping", "description": "The ID assigned to the shipping address", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "dob", "description": "The customer's date of birth", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `date_of_birth` instead" }, { "name": "email", "description": "The customer's email address. Required", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "firstname", "description": "The customer's first name", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "gender", "description": "The customer's gender (Male - 1, Female - 2)", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "group_id", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "Customer group should not be exposed in the storefront scenarios" }, { "name": "id", "description": "The ID assigned to the customer", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "id is not needed as part of Customer because on server side it can be identified based on customer token used for authentication. There is no need to know customer ID on the client side." }, { "name": "is_subscribed", "description": "Indicates whether the customer is subscribed to the company's newsletter", "args": [], "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "lastname", "description": "The customer's family name", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "middlename", "description": "The customer's middle name", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "orders", "description": null, "args": [ { "name": "filter", "description": "Defines the filter to use for searching customer orders", "type": { "kind": "INPUT_OBJECT", "name": "CustomerOrdersFilterInput", "ofType": null }, "defaultValue": null }, { "name": "currentPage", "description": "Specifies which page of results to return. The default value is 1", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": "1" }, { "name": "pageSize", "description": "Specifies the maximum number of results to return at once. The default value is 20", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": "20" } ], "type": { "kind": "OBJECT", "name": "CustomerOrders", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "prefix", "description": "An honorific, such as Dr., Mr., or Mrs.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "return", "description": "Retrieves details about the specified return request from the unique ID for a `Return` object", "args": [ { "name": "uid", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Return", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "returns", "description": "Information about the customer's return requests.", "args": [ { "name": "pageSize", "description": "Specifies the maximum number of results to return at once. The default value is 20", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": "20" }, { "name": "currentPage", "description": "Specifies which page of results to return. The default value is 1", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": "1" } ], "type": { "kind": "OBJECT", "name": "Returns", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "reviews", "description": "Contains the customer's product reviews", "args": [ { "name": "pageSize", "description": "Specifies the maximum number of results to return at once.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": "20" }, { "name": "currentPage", "description": "Specifies which page of results to return.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": "1" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductReviews", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "reward_points", "description": "Customer reward points details", "args": [], "type": { "kind": "OBJECT", "name": "RewardPoints", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "store_credit", "description": "Contains the store credit information applied for the logged in customer", "args": [], "type": { "kind": "OBJECT", "name": "CustomerStoreCredit", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "suffix", "description": "A value such as Sr., Jr., or III", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "taxvat", "description": "The customer's Value-added tax (VAT) number (for corporate customers)", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "wishlist", "description": "Contains a customer's wish lists", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Wishlist", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `Customer.wishlists` or `Customer.wishlist_v2`" }, { "name": "wishlist_v2", "description": "Retrieve the specified wish list identified by the unique ID for a `Wishlist` object", "args": [ { "name": "id", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Wishlist", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "wishlists", "description": "An array of wishlists. In Magento Open Source, customers are limited to one wish list. The number of wish lists is configurable for Adobe Commerce", "args": [ { "name": "pageSize", "description": "Specifies the maximum number of results to return at once. This attribute is optional.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": "20" }, { "name": "currentPage", "description": "Specifies which page of results to return. The default value is 1.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": "1" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "Wishlist", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerAddress", "description": "CustomerAddress contains detailed information about a customer's billing and shipping addresses", "fields": [ { "name": "city", "description": "The city or town", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "company", "description": "The customer's company", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "country_code", "description": "The customer's country", "args": [], "type": { "kind": "ENUM", "name": "CountryCodeEnum", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "country_id", "description": "The customer's country", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `country_code` instead." }, { "name": "custom_attributes", "description": null, "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "CustomerAddressAttribute", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Custom attributes should not be put into container" }, { "name": "customer_id", "description": "The customer ID", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "customer_id is not needed as part of CustomerAddress, address ID (id) is unique identifier for the addresses." }, { "name": "default_billing", "description": "Indicates whether the address is the default billing address", "args": [], "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "default_shipping", "description": "Indicates whether the address is the default shipping address", "args": [], "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "extension_attributes", "description": "Address extension attributes", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "CustomerAddressAttribute", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "fax", "description": "The fax number", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "firstname", "description": "The first name of the person associated with the shipping/billing address", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The ID assigned to the address object", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "lastname", "description": "The family name of the person associated with the shipping/billing address", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "middlename", "description": "The middle name of the person associated with the shipping/billing address", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "postcode", "description": "The customer's ZIP or postal code", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "prefix", "description": "An honorific, such as Dr., Mr., or Mrs.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "region", "description": "An object containing the region name, region code, and region ID", "args": [], "type": { "kind": "OBJECT", "name": "CustomerAddressRegion", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "region_id", "description": "The unique ID for a pre-defined region", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "street", "description": "An array of strings that define the street number and name", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "suffix", "description": "A value such as Sr., Jr., or III", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "telephone", "description": "The telephone number", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "vat_id", "description": "The customer's Value-added tax (VAT) number (for corporate customers)", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CountryCodeEnum", "description": "The list of countries codes", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "AF", "description": "Afghanistan", "isDeprecated": false, "deprecationReason": "" }, { "name": "AX", "description": "Åland Islands", "isDeprecated": false, "deprecationReason": "" }, { "name": "AL", "description": "Albania", "isDeprecated": false, "deprecationReason": "" }, { "name": "DZ", "description": "Algeria", "isDeprecated": false, "deprecationReason": "" }, { "name": "AS", "description": "American Samoa", "isDeprecated": false, "deprecationReason": "" }, { "name": "AD", "description": "Andorra", "isDeprecated": false, "deprecationReason": "" }, { "name": "AO", "description": "Angola", "isDeprecated": false, "deprecationReason": "" }, { "name": "AI", "description": "Anguilla", "isDeprecated": false, "deprecationReason": "" }, { "name": "AQ", "description": "Antarctica", "isDeprecated": false, "deprecationReason": "" }, { "name": "AG", "description": "Antigua & Barbuda", "isDeprecated": false, "deprecationReason": "" }, { "name": "AR", "description": "Argentina", "isDeprecated": false, "deprecationReason": "" }, { "name": "AM", "description": "Armenia", "isDeprecated": false, "deprecationReason": "" }, { "name": "AW", "description": "Aruba", "isDeprecated": false, "deprecationReason": "" }, { "name": "AU", "description": "Australia", "isDeprecated": false, "deprecationReason": "" }, { "name": "AT", "description": "Austria", "isDeprecated": false, "deprecationReason": "" }, { "name": "AZ", "description": "Azerbaijan", "isDeprecated": false, "deprecationReason": "" }, { "name": "BS", "description": "Bahamas", "isDeprecated": false, "deprecationReason": "" }, { "name": "BH", "description": "Bahrain", "isDeprecated": false, "deprecationReason": "" }, { "name": "BD", "description": "Bangladesh", "isDeprecated": false, "deprecationReason": "" }, { "name": "BB", "description": "Barbados", "isDeprecated": false, "deprecationReason": "" }, { "name": "BY", "description": "Belarus", "isDeprecated": false, "deprecationReason": "" }, { "name": "BE", "description": "Belgium", "isDeprecated": false, "deprecationReason": "" }, { "name": "BZ", "description": "Belize", "isDeprecated": false, "deprecationReason": "" }, { "name": "BJ", "description": "Benin", "isDeprecated": false, "deprecationReason": "" }, { "name": "BM", "description": "Bermuda", "isDeprecated": false, "deprecationReason": "" }, { "name": "BT", "description": "Bhutan", "isDeprecated": false, "deprecationReason": "" }, { "name": "BO", "description": "Bolivia", "isDeprecated": false, "deprecationReason": "" }, { "name": "BA", "description": "Bosnia & Herzegovina", "isDeprecated": false, "deprecationReason": "" }, { "name": "BW", "description": "Botswana", "isDeprecated": false, "deprecationReason": "" }, { "name": "BV", "description": "Bouvet Island", "isDeprecated": false, "deprecationReason": "" }, { "name": "BR", "description": "Brazil", "isDeprecated": false, "deprecationReason": "" }, { "name": "IO", "description": "British Indian Ocean Territory", "isDeprecated": false, "deprecationReason": "" }, { "name": "VG", "description": "British Virgin Islands", "isDeprecated": false, "deprecationReason": "" }, { "name": "BN", "description": "Brunei", "isDeprecated": false, "deprecationReason": "" }, { "name": "BG", "description": "Bulgaria", "isDeprecated": false, "deprecationReason": "" }, { "name": "BF", "description": "Burkina Faso", "isDeprecated": false, "deprecationReason": "" }, { "name": "BI", "description": "Burundi", "isDeprecated": false, "deprecationReason": "" }, { "name": "KH", "description": "Cambodia", "isDeprecated": false, "deprecationReason": "" }, { "name": "CM", "description": "Cameroon", "isDeprecated": false, "deprecationReason": "" }, { "name": "CA", "description": "Canada", "isDeprecated": false, "deprecationReason": "" }, { "name": "CV", "description": "Cape Verde", "isDeprecated": false, "deprecationReason": "" }, { "name": "KY", "description": "Cayman Islands", "isDeprecated": false, "deprecationReason": "" }, { "name": "CF", "description": "Central African Republic", "isDeprecated": false, "deprecationReason": "" }, { "name": "TD", "description": "Chad", "isDeprecated": false, "deprecationReason": "" }, { "name": "CL", "description": "Chile", "isDeprecated": false, "deprecationReason": "" }, { "name": "CN", "description": "China", "isDeprecated": false, "deprecationReason": "" }, { "name": "CX", "description": "Christmas Island", "isDeprecated": false, "deprecationReason": "" }, { "name": "CC", "description": "Cocos (Keeling) Islands", "isDeprecated": false, "deprecationReason": "" }, { "name": "CO", "description": "Colombia", "isDeprecated": false, "deprecationReason": "" }, { "name": "KM", "description": "Comoros", "isDeprecated": false, "deprecationReason": "" }, { "name": "CG", "description": "Congo-Brazzaville", "isDeprecated": false, "deprecationReason": "" }, { "name": "CD", "description": "Congo-Kinshasa", "isDeprecated": false, "deprecationReason": "" }, { "name": "CK", "description": "Cook Islands", "isDeprecated": false, "deprecationReason": "" }, { "name": "CR", "description": "Costa Rica", "isDeprecated": false, "deprecationReason": "" }, { "name": "CI", "description": "Côte d’Ivoire", "isDeprecated": false, "deprecationReason": "" }, { "name": "HR", "description": "Croatia", "isDeprecated": false, "deprecationReason": "" }, { "name": "CU", "description": "Cuba", "isDeprecated": false, "deprecationReason": "" }, { "name": "CY", "description": "Cyprus", "isDeprecated": false, "deprecationReason": "" }, { "name": "CZ", "description": "Czech Republic", "isDeprecated": false, "deprecationReason": "" }, { "name": "DK", "description": "Denmark", "isDeprecated": false, "deprecationReason": "" }, { "name": "DJ", "description": "Djibouti", "isDeprecated": false, "deprecationReason": "" }, { "name": "DM", "description": "Dominica", "isDeprecated": false, "deprecationReason": "" }, { "name": "DO", "description": "Dominican Republic", "isDeprecated": false, "deprecationReason": "" }, { "name": "EC", "description": "Ecuador", "isDeprecated": false, "deprecationReason": "" }, { "name": "EG", "description": "Egypt", "isDeprecated": false, "deprecationReason": "" }, { "name": "SV", "description": "El Salvador", "isDeprecated": false, "deprecationReason": "" }, { "name": "GQ", "description": "Equatorial Guinea", "isDeprecated": false, "deprecationReason": "" }, { "name": "ER", "description": "Eritrea", "isDeprecated": false, "deprecationReason": "" }, { "name": "EE", "description": "Estonia", "isDeprecated": false, "deprecationReason": "" }, { "name": "ET", "description": "Ethiopia", "isDeprecated": false, "deprecationReason": "" }, { "name": "FK", "description": "Falkland Islands", "isDeprecated": false, "deprecationReason": "" }, { "name": "FO", "description": "Faroe Islands", "isDeprecated": false, "deprecationReason": "" }, { "name": "FJ", "description": "Fiji", "isDeprecated": false, "deprecationReason": "" }, { "name": "FI", "description": "Finland", "isDeprecated": false, "deprecationReason": "" }, { "name": "FR", "description": "France", "isDeprecated": false, "deprecationReason": "" }, { "name": "GF", "description": "French Guiana", "isDeprecated": false, "deprecationReason": "" }, { "name": "PF", "description": "French Polynesia", "isDeprecated": false, "deprecationReason": "" }, { "name": "TF", "description": "French Southern Territories", "isDeprecated": false, "deprecationReason": "" }, { "name": "GA", "description": "Gabon", "isDeprecated": false, "deprecationReason": "" }, { "name": "GM", "description": "Gambia", "isDeprecated": false, "deprecationReason": "" }, { "name": "GE", "description": "Georgia", "isDeprecated": false, "deprecationReason": "" }, { "name": "DE", "description": "Germany", "isDeprecated": false, "deprecationReason": "" }, { "name": "GH", "description": "Ghana", "isDeprecated": false, "deprecationReason": "" }, { "name": "GI", "description": "Gibraltar", "isDeprecated": false, "deprecationReason": "" }, { "name": "GR", "description": "Greece", "isDeprecated": false, "deprecationReason": "" }, { "name": "GL", "description": "Greenland", "isDeprecated": false, "deprecationReason": "" }, { "name": "GD", "description": "Grenada", "isDeprecated": false, "deprecationReason": "" }, { "name": "GP", "description": "Guadeloupe", "isDeprecated": false, "deprecationReason": "" }, { "name": "GU", "description": "Guam", "isDeprecated": false, "deprecationReason": "" }, { "name": "GT", "description": "Guatemala", "isDeprecated": false, "deprecationReason": "" }, { "name": "GG", "description": "Guernsey", "isDeprecated": false, "deprecationReason": "" }, { "name": "GN", "description": "Guinea", "isDeprecated": false, "deprecationReason": "" }, { "name": "GW", "description": "Guinea-Bissau", "isDeprecated": false, "deprecationReason": "" }, { "name": "GY", "description": "Guyana", "isDeprecated": false, "deprecationReason": "" }, { "name": "HT", "description": "Haiti", "isDeprecated": false, "deprecationReason": "" }, { "name": "HM", "description": "Heard & McDonald Islands", "isDeprecated": false, "deprecationReason": "" }, { "name": "HN", "description": "Honduras", "isDeprecated": false, "deprecationReason": "" }, { "name": "HK", "description": "Hong Kong SAR China", "isDeprecated": false, "deprecationReason": "" }, { "name": "HU", "description": "Hungary", "isDeprecated": false, "deprecationReason": "" }, { "name": "IS", "description": "Iceland", "isDeprecated": false, "deprecationReason": "" }, { "name": "IN", "description": "India", "isDeprecated": false, "deprecationReason": "" }, { "name": "ID", "description": "Indonesia", "isDeprecated": false, "deprecationReason": "" }, { "name": "IR", "description": "Iran", "isDeprecated": false, "deprecationReason": "" }, { "name": "IQ", "description": "Iraq", "isDeprecated": false, "deprecationReason": "" }, { "name": "IE", "description": "Ireland", "isDeprecated": false, "deprecationReason": "" }, { "name": "IM", "description": "Isle of Man", "isDeprecated": false, "deprecationReason": "" }, { "name": "IL", "description": "Israel", "isDeprecated": false, "deprecationReason": "" }, { "name": "IT", "description": "Italy", "isDeprecated": false, "deprecationReason": "" }, { "name": "JM", "description": "Jamaica", "isDeprecated": false, "deprecationReason": "" }, { "name": "JP", "description": "Japan", "isDeprecated": false, "deprecationReason": "" }, { "name": "JE", "description": "Jersey", "isDeprecated": false, "deprecationReason": "" }, { "name": "JO", "description": "Jordan", "isDeprecated": false, "deprecationReason": "" }, { "name": "KZ", "description": "Kazakhstan", "isDeprecated": false, "deprecationReason": "" }, { "name": "KE", "description": "Kenya", "isDeprecated": false, "deprecationReason": "" }, { "name": "KI", "description": "Kiribati", "isDeprecated": false, "deprecationReason": "" }, { "name": "KW", "description": "Kuwait", "isDeprecated": false, "deprecationReason": "" }, { "name": "KG", "description": "Kyrgyzstan", "isDeprecated": false, "deprecationReason": "" }, { "name": "LA", "description": "Laos", "isDeprecated": false, "deprecationReason": "" }, { "name": "LV", "description": "Latvia", "isDeprecated": false, "deprecationReason": "" }, { "name": "LB", "description": "Lebanon", "isDeprecated": false, "deprecationReason": "" }, { "name": "LS", "description": "Lesotho", "isDeprecated": false, "deprecationReason": "" }, { "name": "LR", "description": "Liberia", "isDeprecated": false, "deprecationReason": "" }, { "name": "LY", "description": "Libya", "isDeprecated": false, "deprecationReason": "" }, { "name": "LI", "description": "Liechtenstein", "isDeprecated": false, "deprecationReason": "" }, { "name": "LT", "description": "Lithuania", "isDeprecated": false, "deprecationReason": "" }, { "name": "LU", "description": "Luxembourg", "isDeprecated": false, "deprecationReason": "" }, { "name": "MO", "description": "Macau SAR China", "isDeprecated": false, "deprecationReason": "" }, { "name": "MK", "description": "Macedonia", "isDeprecated": false, "deprecationReason": "" }, { "name": "MG", "description": "Madagascar", "isDeprecated": false, "deprecationReason": "" }, { "name": "MW", "description": "Malawi", "isDeprecated": false, "deprecationReason": "" }, { "name": "MY", "description": "Malaysia", "isDeprecated": false, "deprecationReason": "" }, { "name": "MV", "description": "Maldives", "isDeprecated": false, "deprecationReason": "" }, { "name": "ML", "description": "Mali", "isDeprecated": false, "deprecationReason": "" }, { "name": "MT", "description": "Malta", "isDeprecated": false, "deprecationReason": "" }, { "name": "MH", "description": "Marshall Islands", "isDeprecated": false, "deprecationReason": "" }, { "name": "MQ", "description": "Martinique", "isDeprecated": false, "deprecationReason": "" }, { "name": "MR", "description": "Mauritania", "isDeprecated": false, "deprecationReason": "" }, { "name": "MU", "description": "Mauritius", "isDeprecated": false, "deprecationReason": "" }, { "name": "YT", "description": "Mayotte", "isDeprecated": false, "deprecationReason": "" }, { "name": "MX", "description": "Mexico", "isDeprecated": false, "deprecationReason": "" }, { "name": "FM", "description": "Micronesia", "isDeprecated": false, "deprecationReason": "" }, { "name": "MD", "description": "Moldova", "isDeprecated": false, "deprecationReason": "" }, { "name": "MC", "description": "Monaco", "isDeprecated": false, "deprecationReason": "" }, { "name": "MN", "description": "Mongolia", "isDeprecated": false, "deprecationReason": "" }, { "name": "ME", "description": "Montenegro", "isDeprecated": false, "deprecationReason": "" }, { "name": "MS", "description": "Montserrat", "isDeprecated": false, "deprecationReason": "" }, { "name": "MA", "description": "Morocco", "isDeprecated": false, "deprecationReason": "" }, { "name": "MZ", "description": "Mozambique", "isDeprecated": false, "deprecationReason": "" }, { "name": "MM", "description": "Myanmar (Burma)", "isDeprecated": false, "deprecationReason": "" }, { "name": "NA", "description": "Namibia", "isDeprecated": false, "deprecationReason": "" }, { "name": "NR", "description": "Nauru", "isDeprecated": false, "deprecationReason": "" }, { "name": "NP", "description": "Nepal", "isDeprecated": false, "deprecationReason": "" }, { "name": "NL", "description": "Netherlands", "isDeprecated": false, "deprecationReason": "" }, { "name": "AN", "description": "Netherlands Antilles", "isDeprecated": false, "deprecationReason": "" }, { "name": "NC", "description": "New Caledonia", "isDeprecated": false, "deprecationReason": "" }, { "name": "NZ", "description": "New Zealand", "isDeprecated": false, "deprecationReason": "" }, { "name": "NI", "description": "Nicaragua", "isDeprecated": false, "deprecationReason": "" }, { "name": "NE", "description": "Niger", "isDeprecated": false, "deprecationReason": "" }, { "name": "NG", "description": "Nigeria", "isDeprecated": false, "deprecationReason": "" }, { "name": "NU", "description": "Niue", "isDeprecated": false, "deprecationReason": "" }, { "name": "NF", "description": "Norfolk Island", "isDeprecated": false, "deprecationReason": "" }, { "name": "MP", "description": "Northern Mariana Islands", "isDeprecated": false, "deprecationReason": "" }, { "name": "KP", "description": "North Korea", "isDeprecated": false, "deprecationReason": "" }, { "name": "NO", "description": "Norway", "isDeprecated": false, "deprecationReason": "" }, { "name": "OM", "description": "Oman", "isDeprecated": false, "deprecationReason": "" }, { "name": "PK", "description": "Pakistan", "isDeprecated": false, "deprecationReason": "" }, { "name": "PW", "description": "Palau", "isDeprecated": false, "deprecationReason": "" }, { "name": "PS", "description": "Palestinian Territories", "isDeprecated": false, "deprecationReason": "" }, { "name": "PA", "description": "Panama", "isDeprecated": false, "deprecationReason": "" }, { "name": "PG", "description": "Papua New Guinea", "isDeprecated": false, "deprecationReason": "" }, { "name": "PY", "description": "Paraguay", "isDeprecated": false, "deprecationReason": "" }, { "name": "PE", "description": "Peru", "isDeprecated": false, "deprecationReason": "" }, { "name": "PH", "description": "Philippines", "isDeprecated": false, "deprecationReason": "" }, { "name": "PN", "description": "Pitcairn Islands", "isDeprecated": false, "deprecationReason": "" }, { "name": "PL", "description": "Poland", "isDeprecated": false, "deprecationReason": "" }, { "name": "PT", "description": "Portugal", "isDeprecated": false, "deprecationReason": "" }, { "name": "QA", "description": "Qatar", "isDeprecated": false, "deprecationReason": "" }, { "name": "RE", "description": "Réunion", "isDeprecated": false, "deprecationReason": "" }, { "name": "RO", "description": "Romania", "isDeprecated": false, "deprecationReason": "" }, { "name": "RU", "description": "Russia", "isDeprecated": false, "deprecationReason": "" }, { "name": "RW", "description": "Rwanda", "isDeprecated": false, "deprecationReason": "" }, { "name": "WS", "description": "Samoa", "isDeprecated": false, "deprecationReason": "" }, { "name": "SM", "description": "San Marino", "isDeprecated": false, "deprecationReason": "" }, { "name": "ST", "description": "São Tomé & Príncipe", "isDeprecated": false, "deprecationReason": "" }, { "name": "SA", "description": "Saudi Arabia", "isDeprecated": false, "deprecationReason": "" }, { "name": "SN", "description": "Senegal", "isDeprecated": false, "deprecationReason": "" }, { "name": "RS", "description": "Serbia", "isDeprecated": false, "deprecationReason": "" }, { "name": "SC", "description": "Seychelles", "isDeprecated": false, "deprecationReason": "" }, { "name": "SL", "description": "Sierra Leone", "isDeprecated": false, "deprecationReason": "" }, { "name": "SG", "description": "Singapore", "isDeprecated": false, "deprecationReason": "" }, { "name": "SK", "description": "Slovakia", "isDeprecated": false, "deprecationReason": "" }, { "name": "SI", "description": "Slovenia", "isDeprecated": false, "deprecationReason": "" }, { "name": "SB", "description": "Solomon Islands", "isDeprecated": false, "deprecationReason": "" }, { "name": "SO", "description": "Somalia", "isDeprecated": false, "deprecationReason": "" }, { "name": "ZA", "description": "South Africa", "isDeprecated": false, "deprecationReason": "" }, { "name": "GS", "description": "South Georgia & South Sandwich Islands", "isDeprecated": false, "deprecationReason": "" }, { "name": "KR", "description": "South Korea", "isDeprecated": false, "deprecationReason": "" }, { "name": "ES", "description": "Spain", "isDeprecated": false, "deprecationReason": "" }, { "name": "LK", "description": "Sri Lanka", "isDeprecated": false, "deprecationReason": "" }, { "name": "BL", "description": "St. Barthélemy", "isDeprecated": false, "deprecationReason": "" }, { "name": "SH", "description": "St. Helena", "isDeprecated": false, "deprecationReason": "" }, { "name": "KN", "description": "St. Kitts & Nevis", "isDeprecated": false, "deprecationReason": "" }, { "name": "LC", "description": "St. Lucia", "isDeprecated": false, "deprecationReason": "" }, { "name": "MF", "description": "St. Martin", "isDeprecated": false, "deprecationReason": "" }, { "name": "PM", "description": "St. Pierre & Miquelon", "isDeprecated": false, "deprecationReason": "" }, { "name": "VC", "description": "St. Vincent & Grenadines", "isDeprecated": false, "deprecationReason": "" }, { "name": "SD", "description": "Sudan", "isDeprecated": false, "deprecationReason": "" }, { "name": "SR", "description": "Suriname", "isDeprecated": false, "deprecationReason": "" }, { "name": "SJ", "description": "Svalbard & Jan Mayen", "isDeprecated": false, "deprecationReason": "" }, { "name": "SZ", "description": "Swaziland", "isDeprecated": false, "deprecationReason": "" }, { "name": "SE", "description": "Sweden", "isDeprecated": false, "deprecationReason": "" }, { "name": "CH", "description": "Switzerland", "isDeprecated": false, "deprecationReason": "" }, { "name": "SY", "description": "Syria", "isDeprecated": false, "deprecationReason": "" }, { "name": "TW", "description": "Taiwan", "isDeprecated": false, "deprecationReason": "" }, { "name": "TJ", "description": "Tajikistan", "isDeprecated": false, "deprecationReason": "" }, { "name": "TZ", "description": "Tanzania", "isDeprecated": false, "deprecationReason": "" }, { "name": "TH", "description": "Thailand", "isDeprecated": false, "deprecationReason": "" }, { "name": "TL", "description": "Timor-Leste", "isDeprecated": false, "deprecationReason": "" }, { "name": "TG", "description": "Togo", "isDeprecated": false, "deprecationReason": "" }, { "name": "TK", "description": "Tokelau", "isDeprecated": false, "deprecationReason": "" }, { "name": "TO", "description": "Tonga", "isDeprecated": false, "deprecationReason": "" }, { "name": "TT", "description": "Trinidad & Tobago", "isDeprecated": false, "deprecationReason": "" }, { "name": "TN", "description": "Tunisia", "isDeprecated": false, "deprecationReason": "" }, { "name": "TR", "description": "Turkey", "isDeprecated": false, "deprecationReason": "" }, { "name": "TM", "description": "Turkmenistan", "isDeprecated": false, "deprecationReason": "" }, { "name": "TC", "description": "Turks & Caicos Islands", "isDeprecated": false, "deprecationReason": "" }, { "name": "TV", "description": "Tuvalu", "isDeprecated": false, "deprecationReason": "" }, { "name": "UG", "description": "Uganda", "isDeprecated": false, "deprecationReason": "" }, { "name": "UA", "description": "Ukraine", "isDeprecated": false, "deprecationReason": "" }, { "name": "AE", "description": "United Arab Emirates", "isDeprecated": false, "deprecationReason": "" }, { "name": "GB", "description": "United Kingdom", "isDeprecated": false, "deprecationReason": "" }, { "name": "US", "description": "United States", "isDeprecated": false, "deprecationReason": "" }, { "name": "UY", "description": "Uruguay", "isDeprecated": false, "deprecationReason": "" }, { "name": "UM", "description": "U.S. Outlying Islands", "isDeprecated": false, "deprecationReason": "" }, { "name": "VI", "description": "U.S. Virgin Islands", "isDeprecated": false, "deprecationReason": "" }, { "name": "UZ", "description": "Uzbekistan", "isDeprecated": false, "deprecationReason": "" }, { "name": "VU", "description": "Vanuatu", "isDeprecated": false, "deprecationReason": "" }, { "name": "VA", "description": "Vatican City", "isDeprecated": false, "deprecationReason": "" }, { "name": "VE", "description": "Venezuela", "isDeprecated": false, "deprecationReason": "" }, { "name": "VN", "description": "Vietnam", "isDeprecated": false, "deprecationReason": "" }, { "name": "WF", "description": "Wallis & Futuna", "isDeprecated": false, "deprecationReason": "" }, { "name": "EH", "description": "Western Sahara", "isDeprecated": false, "deprecationReason": "" }, { "name": "YE", "description": "Yemen", "isDeprecated": false, "deprecationReason": "" }, { "name": "ZM", "description": "Zambia", "isDeprecated": false, "deprecationReason": "" }, { "name": "ZW", "description": "Zimbabwe", "isDeprecated": false, "deprecationReason": "" } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerAddressAttribute", "description": "", "fields": [ { "name": "attribute_code", "description": "Attribute code", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "Attribute value", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerAddressRegion", "description": "CustomerAddressRegion defines the customer's state or province", "fields": [ { "name": "region", "description": "The state or province name", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "region_code", "description": "The address region code", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "region_id", "description": "The unique ID for a pre-defined region", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CustomerOrdersFilterInput", "description": "Identifies the filter to use for filtering orders.", "fields": null, "inputFields": [ { "name": "number", "description": "Filters by order number.", "type": { "kind": "INPUT_OBJECT", "name": "FilterStringTypeInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "FilterStringTypeInput", "description": "Defines a filter for an input string.", "fields": null, "inputFields": [ { "name": "eq", "description": "Filters items that are exactly the same as the specified string.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "in", "description": "Filters items that are exactly the same as entries specified in an array of strings.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "match", "description": "Defines a filter that performs a fuzzy search using the specified string.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerOrders", "description": "The collection of orders that match the conditions defined in the filter", "fields": [ { "name": "items", "description": "An array of customer orders", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "CustomerOrder", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "page_info", "description": "An object that includes the current_page, page_info, and page_size values specified in the query", "args": [], "type": { "kind": "OBJECT", "name": "SearchResultPageInfo", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "total_count", "description": "The total count of customer orders", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerOrder", "description": "Contains details about each of the customer's orders", "fields": [ { "name": "billing_address", "description": "The billing address for the order", "args": [], "type": { "kind": "OBJECT", "name": "OrderAddress", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "carrier", "description": "The shipping carrier for the order delivery", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "comments", "description": "Comments about the order", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "SalesCommentItem", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "created_at", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use the order_date attribute instead" }, { "name": "credit_memos", "description": "A list of credit memos", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "CreditMemo", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "gift_message", "description": "The entered gift message for the order", "args": [], "type": { "kind": "OBJECT", "name": "GiftMessage", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "gift_receipt_included", "description": "Whether customer requested gift receipt for the order", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "gift_wrapping", "description": "The selected gift wrapping for the order", "args": [], "type": { "kind": "OBJECT", "name": "GiftWrapping", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "grand_total", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use the totals.grand_total attribute instead" }, { "name": "id", "description": "The unique ID for a `CustomerOrder` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "increment_id", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use the id attribute instead" }, { "name": "invoices", "description": "A list of invoices for the order", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "Invoice", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "items", "description": "An array containing the items purchased in this order", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "OrderItemInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "items_eligible_for_return", "description": "A list of order items eligible to be in a return request", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "OrderItemInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "number", "description": "The order number", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "order_date", "description": "The date the order was placed", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "order_number", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use the number attribute instead" }, { "name": "payment_methods", "description": "Payment details for the order", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "OrderPaymentMethod", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "printed_card_included", "description": "Whether customer requested printed card for the order", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "returns", "description": "Return requests associated with this order.", "args": [ { "name": "pageSize", "description": "Specifies the maximum number of results to return at once. The default value is 20", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": "20" }, { "name": "currentPage", "description": "Specifies which page of results to return. The default value is 1", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": "1" } ], "type": { "kind": "OBJECT", "name": "Returns", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "shipments", "description": "A list of shipments for the order", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "OrderShipment", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "shipping_address", "description": "The shipping address for the order", "args": [], "type": { "kind": "OBJECT", "name": "OrderAddress", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "shipping_method", "description": "The delivery method for the order", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "The current status of the order", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "total", "description": "Contains details about the calculated totals for this order", "args": [], "type": { "kind": "OBJECT", "name": "OrderTotal", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderAddress", "description": "OrderAddress contains detailed information about an order's billing and shipping addresses", "fields": [ { "name": "city", "description": "The city or town", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "company", "description": "The customer's company", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "country_code", "description": "The customer's country", "args": [], "type": { "kind": "ENUM", "name": "CountryCodeEnum", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fax", "description": "The fax number", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "firstname", "description": "The first name of the person associated with the shipping/billing address", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "lastname", "description": "The family name of the person associated with the shipping/billing address", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "middlename", "description": "The middle name of the person associated with the shipping/billing address", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "postcode", "description": "The customer's order ZIP or postal code", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "prefix", "description": "An honorific, such as Dr., Mr., or Mrs.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "region", "description": "The state or province name", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "region_id", "description": "The unique ID for a `Region` object of a pre-defined region", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "street", "description": "An array of strings that define the street number and name", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "suffix", "description": "A value such as Sr., Jr., or III", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "telephone", "description": "The telephone number", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "vat_id", "description": "The customer's Value-added tax (VAT) number (for corporate customers)", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SalesCommentItem", "description": "Comment item details", "fields": [ { "name": "message", "description": "The text of the message", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "timestamp", "description": "The timestamp of the comment", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CreditMemo", "description": "Credit memo details", "fields": [ { "name": "comments", "description": "Comments on the credit memo", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "SalesCommentItem", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The unique ID for a `CreditMemo` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "items", "description": "An array containing details about refunded items", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "CreditMemoItemInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "number", "description": "The sequential credit memo number", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "total", "description": "Contains details about the total refunded amount", "args": [], "type": { "kind": "OBJECT", "name": "CreditMemoTotal", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INTERFACE", "name": "CreditMemoItemInterface", "description": "Credit memo item details", "fields": [ { "name": "discounts", "description": "Contains information about the final discount amount for the base product, including discounts on options", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "Discount", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The unique ID for a `CreditMemoItemInterface` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "order_item", "description": "The order item the credit memo is applied to", "args": [], "type": { "kind": "INTERFACE", "name": "OrderItemInterface", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_name", "description": "The name of the base product", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_sale_price", "description": "The sale price for the base product, including selected options", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_sku", "description": "SKU of the base product", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity_refunded", "description": "The number of refunded items", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "DownloadableCreditMemoItem", "ofType": null }, { "kind": "OBJECT", "name": "BundleCreditMemoItem", "ofType": null }, { "kind": "OBJECT", "name": "CreditMemoItem", "ofType": null }, { "kind": "OBJECT", "name": "GiftCardCreditMemoItem", "ofType": null } ] }, { "kind": "INTERFACE", "name": "OrderItemInterface", "description": "Order item details", "fields": [ { "name": "discounts", "description": "The final discount information for the product", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "Discount", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "eligible_for_return", "description": "Indicates whether the order item is eligible is eligible to be in a return request", "args": [], "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "entered_options", "description": "The entered option for the base product, such as a logo or image", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "OrderItemOption", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "gift_wrapping", "description": "The selected gift wrapping for the order item", "args": [], "type": { "kind": "OBJECT", "name": "GiftWrapping", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The unique ID for a `OrderItemInterface` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_name", "description": "The name of the base product", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_sale_price", "description": "The sale price of the base product, including selected options", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_sku", "description": "The SKU of the base product", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_type", "description": "The type of product, such as simple, configurable, etc.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_url_key", "description": "URL key of the base product", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity_canceled", "description": "The number of canceled items", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity_invoiced", "description": "The number of invoiced items", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity_ordered", "description": "The number of units ordered for this item", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity_refunded", "description": "The number of refunded items", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity_returned", "description": "The number of returned items", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity_shipped", "description": "The number of shipped items", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "selected_options", "description": "The selected options for the base product, such as color or size", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "OrderItemOption", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "The status of the order item", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "DownloadableOrderItem", "ofType": null }, { "kind": "OBJECT", "name": "BundleOrderItem", "ofType": null }, { "kind": "OBJECT", "name": "OrderItem", "ofType": null }, { "kind": "OBJECT", "name": "GiftCardOrderItem", "ofType": null } ] }, { "kind": "OBJECT", "name": "OrderItemOption", "description": "Represents order item options like selected or entered", "fields": [ { "name": "label", "description": "The name of the option", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "The value of the option", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CreditMemoTotal", "description": "Credit memo price details", "fields": [ { "name": "adjustment", "description": "An adjustment manually applied to the order", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "base_grand_total", "description": "The final base grand total amount in the base currency", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discounts", "description": "The applied discounts to the credit memo", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "Discount", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "grand_total", "description": "The final total amount, including shipping, discounts, and taxes", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "shipping_handling", "description": "Contains details about the shipping and handling costs for the credit memo", "args": [], "type": { "kind": "OBJECT", "name": "ShippingHandling", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "subtotal", "description": "The subtotal of the invoice, excluding shipping, discounts, and taxes", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "taxes", "description": "The credit memo tax details", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "TaxItem", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "total_shipping", "description": "The shipping amount for the credit memo", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "total_tax", "description": "The amount of tax applied to the credit memo", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ShippingHandling", "description": "The Shipping handling details", "fields": [ { "name": "amount_excluding_tax", "description": "The shipping amount, excluding tax", "args": [], "type": { "kind": "OBJECT", "name": "Money", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "amount_including_tax", "description": "The shipping amount, including tax", "args": [], "type": { "kind": "OBJECT", "name": "Money", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "discounts", "description": "The applied discounts to the shipping", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "ShippingDiscount", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "taxes", "description": "Contains details about taxes applied for shipping", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "TaxItem", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "total_amount", "description": "The total amount for shipping", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ShippingDiscount", "description": "Defines an individual shipping discount. This discount can be applied to shipping.", "fields": [ { "name": "amount", "description": "The amount of the discount", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "TaxItem", "description": "The tax item details", "fields": [ { "name": "amount", "description": "The amount of tax applied to the item", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "rate", "description": "The rate used to calculate the tax", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "A title that describes the tax", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "Invoice", "description": "Invoice details", "fields": [ { "name": "comments", "description": "Comments on the invoice", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "SalesCommentItem", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The unique ID for a `Invoice` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "items", "description": "Invoiced product details", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "InvoiceItemInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "number", "description": "Sequential invoice number", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "total", "description": "Invoice total amount details", "args": [], "type": { "kind": "OBJECT", "name": "InvoiceTotal", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INTERFACE", "name": "InvoiceItemInterface", "description": "Invoice item details", "fields": [ { "name": "discounts", "description": "Contains information about the final discount amount for the base product, including discounts on options", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "Discount", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The unique ID for a `InvoiceItemInterface` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "order_item", "description": "Contains details about an individual order item", "args": [], "type": { "kind": "INTERFACE", "name": "OrderItemInterface", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_name", "description": "The name of the base product", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_sale_price", "description": "The sale price for the base product including selected options", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_sku", "description": "The SKU of the base product", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity_invoiced", "description": "The number of invoiced items", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "DownloadableInvoiceItem", "ofType": null }, { "kind": "OBJECT", "name": "BundleInvoiceItem", "ofType": null }, { "kind": "OBJECT", "name": "InvoiceItem", "ofType": null }, { "kind": "OBJECT", "name": "GiftCardInvoiceItem", "ofType": null } ] }, { "kind": "OBJECT", "name": "InvoiceTotal", "description": "Contains price details from an invoice", "fields": [ { "name": "base_grand_total", "description": "The final base grand total amount in the base currency", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discounts", "description": "The applied discounts to the invoice", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "Discount", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "grand_total", "description": "The final total amount, including shipping, discounts, and taxes", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "shipping_handling", "description": "Contains details about the shipping and handling costs for the invoice", "args": [], "type": { "kind": "OBJECT", "name": "ShippingHandling", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "subtotal", "description": "The subtotal of the invoice, excluding shipping, discounts, and taxes", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "taxes", "description": "The invoice tax details", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "TaxItem", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "total_shipping", "description": "The shipping amount for the invoice", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "total_tax", "description": "The amount of tax applied to the invoice", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderPaymentMethod", "description": "Contains details about the payment method used to pay for the order", "fields": [ { "name": "additional_data", "description": "Additional data per payment method type", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "KeyValue", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The label that describes the payment method", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "type", "description": "The payment method code that indicates how the order was paid for", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "KeyValue", "description": "The key-value type", "fields": [ { "name": "name", "description": "The name part of the name/value pair", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "The value part of the name/value pair", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "Returns", "description": "", "fields": [ { "name": "items", "description": "A list of return requests", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "Return", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "page_info", "description": "Pagination metadata", "args": [], "type": { "kind": "OBJECT", "name": "SearchResultPageInfo", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "total_count", "description": "The total number of return requests", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "Return", "description": "Customer return", "fields": [ { "name": "available_shipping_carriers", "description": "A list of shipping carriers available for returns", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "ReturnShippingCarrier", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "comments", "description": "A list of comments posted for the return request", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "ReturnComment", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "created_at", "description": "The date the return was requested", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customer", "description": "The data from customer who created the return request", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ReturnCustomer", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "items", "description": "A list of items being returned", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "ReturnItem", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "number", "description": "Human-readable return number", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "order", "description": "The order associated with the return", "args": [], "type": { "kind": "OBJECT", "name": "CustomerOrder", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "shipping", "description": "Shipping information for the return", "args": [], "type": { "kind": "OBJECT", "name": "ReturnShipping", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "The status of the return request", "args": [], "type": { "kind": "ENUM", "name": "ReturnStatus", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "uid", "description": "The unique ID for a `Return` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ReturnShippingCarrier", "description": "", "fields": [ { "name": "label", "description": "A description of the shipping carrier", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "uid", "description": "The unique ID for a `ReturnShippingCarrier` object assigned to the shipping carrier", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ReturnComment", "description": "", "fields": [ { "name": "author_name", "description": "The name or author who posted the comment", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "created_at", "description": "The date and time the comment was posted", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "text", "description": "The contents of the comment", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "uid", "description": "The unique ID for a `ReturnComment` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ReturnCustomer", "description": "The Customer information for the return.", "fields": [ { "name": "email", "description": "Customer email address.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "firstname", "description": "Customer first name.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "lastname", "description": "Customer last name.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ReturnItem", "description": "", "fields": [ { "name": "custom_attributes", "description": "Return item custom attributes that are visible on the storefront", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "ReturnCustomAttribute", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "order_item", "description": "Provides access to the product being returned, including information about selected and entered options", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INTERFACE", "name": "OrderItemInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity", "description": "The quantity of the item the merchant authorized to be returned", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "request_quantity", "description": "The quantity of the item requested to be returned", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "The return status of the item", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "ReturnItemStatus", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "uid", "description": "The unique ID for a `ReturnItem` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ReturnCustomAttribute", "description": "", "fields": [ { "name": "label", "description": "A description of the attribute", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "uid", "description": "The unique ID for a `ReturnCustomAttribute` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "A JSON-encoded value of the attribute", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ReturnItemStatus", "description": "", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "PENDING", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "AUTHORIZED", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "RECEIVED", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "APPROVED", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "REJECTED", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "DENIED", "description": "", "isDeprecated": false, "deprecationReason": "" } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "ReturnShipping", "description": "", "fields": [ { "name": "address", "description": "The merchant-defined return shipping address", "args": [], "type": { "kind": "OBJECT", "name": "ReturnShippingAddress", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "tracking", "description": "The unique ID for a `ReturnShippingTracking` object. If a single UID is specified, contains a single tracking record. Otherwise, contains all tracking information", "args": [ { "name": "uid", "description": "", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "ReturnShippingTracking", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ReturnShippingAddress", "description": "", "fields": [ { "name": "city", "description": "The city for product returns", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "contact_name", "description": "The merchant's contact person", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "country", "description": "An object that defines the country for product returns", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Country", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "postcode", "description": "The postal code for product returns", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "region", "description": "An object that defines the state or province for product returns", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Region", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "street", "description": "The street address for product returns", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "telephone", "description": "The telephone number for product returns", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ReturnShippingTracking", "description": "", "fields": [ { "name": "carrier", "description": "Contains details of a shipping carrier", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ReturnShippingCarrier", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "Contains details about the status of a shipment", "args": [], "type": { "kind": "OBJECT", "name": "ReturnShippingTrackingStatus", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "tracking_number", "description": "A tracking number assigned by the carrier", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "uid", "description": "The unique ID for a `ReturnShippingTracking` object assigned to the tracking item", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ReturnShippingTrackingStatus", "description": "", "fields": [ { "name": "text", "description": "Text that describes the status", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "type", "description": "Indicates whether the status type is informational or an error", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "ReturnShippingTrackingStatusType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "ReturnShippingTrackingStatusType", "description": "", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "INFORMATION", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "ERROR", "description": "", "isDeprecated": false, "deprecationReason": "" } ], "possibleTypes": null }, { "kind": "ENUM", "name": "ReturnStatus", "description": "", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "PENDING", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "AUTHORIZED", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "PARTIALLY_AUTHORIZED", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "RECEIVED", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "PARTIALLY_RECEIVED", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "APPROVED", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "PARTIALLY_APPROVED", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "REJECTED", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "PARTIALLY_REJECTED", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "DENIED", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "PROCESSED_AND_CLOSED", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "CLOSED", "description": "", "isDeprecated": false, "deprecationReason": "" } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderShipment", "description": "Order shipment details", "fields": [ { "name": "comments", "description": "Comments added to the shipment", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "SalesCommentItem", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The unique ID for a `OrderShipment` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "items", "description": "Contains items included in the shipment", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "ShipmentItemInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "number", "description": "The sequential credit shipment number", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "tracking", "description": "Contains shipment tracking details", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "ShipmentTracking", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INTERFACE", "name": "ShipmentItemInterface", "description": "Order shipment item details", "fields": [ { "name": "id", "description": "The unique ID for a `ShipmentItemInterface` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "order_item", "description": "Associated order item", "args": [], "type": { "kind": "INTERFACE", "name": "OrderItemInterface", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_name", "description": "Name of the base product", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_sale_price", "description": "Sale price for the base product", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_sku", "description": "SKU of the base product", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity_shipped", "description": "Number of shipped items", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "BundleShipmentItem", "ofType": null }, { "kind": "OBJECT", "name": "ShipmentItem", "ofType": null }, { "kind": "OBJECT", "name": "GiftCardShipmentItem", "ofType": null } ] }, { "kind": "OBJECT", "name": "ShipmentTracking", "description": "Order shipment tracking details", "fields": [ { "name": "carrier", "description": "The shipping carrier for the order delivery", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "number", "description": "The tracking number of the order shipment", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The shipment tracking title", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderTotal", "description": "Contains details about the sales total amounts used to calculate the final price", "fields": [ { "name": "base_grand_total", "description": "The final base grand total amount in the base currency", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discounts", "description": "The applied discounts to the order", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "Discount", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "grand_total", "description": "The final total amount, including shipping, discounts, and taxes", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "shipping_handling", "description": "Contains details about the shipping and handling costs for the order", "args": [], "type": { "kind": "OBJECT", "name": "ShippingHandling", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "subtotal", "description": "The subtotal of the order, excluding shipping, discounts, and taxes", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "taxes", "description": "The order tax details", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "TaxItem", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "total_shipping", "description": "The shipping amount for the order", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "total_tax", "description": "The amount of tax applied to the order", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "RewardPoints", "description": "", "fields": [ { "name": "balance", "description": "The current balance of reward points", "args": [], "type": { "kind": "OBJECT", "name": "RewardPointsAmount", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "balance_history", "description": "The balance history of reward points. If the ability for customers to view the balance history has been disabled in the Admin, this field will be set to null", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "RewardPointsBalanceHistoryItem", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "exchange_rates", "description": "The current exchange rates for reward points", "args": [], "type": { "kind": "OBJECT", "name": "RewardPointsExchangeRates", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "subscription_status", "description": "The subscription status of emails related to reward points", "args": [], "type": { "kind": "OBJECT", "name": "RewardPointsSubscriptionStatus", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "RewardPointsBalanceHistoryItem", "description": "", "fields": [ { "name": "balance", "description": "Reward points balance after the completion of the transaction", "args": [], "type": { "kind": "OBJECT", "name": "RewardPointsAmount", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "change_reason", "description": "The reason the balance changed", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "date", "description": "Transaction date", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "points_change", "description": "The number of points added or deducted in the transaction", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "RewardPointsExchangeRates", "description": "Exchange rates depend on the customer group", "fields": [ { "name": "earning", "description": "How many points are earned for a given amount spent", "args": [], "type": { "kind": "OBJECT", "name": "RewardPointsRate", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "redemption", "description": "How many points must be redeemed to get a given amount of currency discount at the checkout", "args": [], "type": { "kind": "OBJECT", "name": "RewardPointsRate", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "RewardPointsRate", "description": "", "fields": [ { "name": "currency_amount", "description": "The money value for exchange rate. For earnings this is amount spent to earn the specified points. For redemption this is the amount of money the number of points represents.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "points", "description": "The number of points for exchange rate. For earnings this is the number of points earned. For redemption this is the number of points needed for redemption.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "RewardPointsSubscriptionStatus", "description": "", "fields": [ { "name": "balance_updates", "description": "Customer subscription status to 'Reward points balance updates' emails", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "RewardPointsSubscriptionStatusesEnum", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "points_expiration_notifications", "description": "Customer subscription status to 'Reward points expiration notifications' emails", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "RewardPointsSubscriptionStatusesEnum", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "RewardPointsSubscriptionStatusesEnum", "description": "", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "SUBSCRIBED", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "NOT_SUBSCRIBED", "description": "", "isDeprecated": false, "deprecationReason": "" } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerStoreCredit", "description": "Contains store credit information with balance and history", "fields": [ { "name": "balance_history", "description": "Customer Store credit balance history. If the history or store credit feature is disabled, then a null value will be returned.", "args": [ { "name": "pageSize", "description": "Specifies the maximum number of results to return at once. This value is optional. The default value is 20", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": "20" }, { "name": "currentPage", "description": "Specifies which page of results to return. This value is optional. The default value is 1.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": "1" } ], "type": { "kind": "OBJECT", "name": "CustomerStoreCreditHistory", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "current_balance", "description": "Current balance on store credit", "args": [], "type": { "kind": "OBJECT", "name": "Money", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "enabled", "description": "Indicates whether store credits are enabled. If the feature is disabled, then the balance will not be returned", "args": [], "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerStoreCreditHistory", "description": "Lists changes to the amount of store credit available to the customer.", "fields": [ { "name": "items", "description": "An array containing information about changes to the store credit available to the customer.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "CustomerStoreCreditHistoryItem", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "page_info", "description": "An object that includes the current_page page_info and page_size values specified in the query.", "args": [], "type": { "kind": "OBJECT", "name": "SearchResultPageInfo", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "total_count", "description": "The number of items returned.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerStoreCreditHistoryItem", "description": "Defines store credit history information", "fields": [ { "name": "action", "description": "Action that was made on the store credit", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "actual_balance", "description": "The store credit available to the customer as a result of this action. ", "args": [], "type": { "kind": "OBJECT", "name": "Money", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "balance_change", "description": "The amount added to or subtracted from the store credit as a result of this action.", "args": [], "type": { "kind": "OBJECT", "name": "Money", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "date_time_changed", "description": "Date and time when the store credit change was made", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "Wishlist", "description": "", "fields": [ { "name": "id", "description": "The unique ID for a `Wishlist` object", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "items", "description": null, "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "WishlistItem", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use field `items_v2` from type `Wishlist` instead" }, { "name": "items_count", "description": "The number of items in the wish list", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "items_v2", "description": "An array of items in the customer's wish list", "args": [ { "name": "currentPage", "description": "", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": "1" }, { "name": "pageSize", "description": "", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": "20" } ], "type": { "kind": "OBJECT", "name": "WishlistItems", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The wish list name", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sharing_code", "description": "An encrypted code that Magento uses to link to the wish list", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "updated_at", "description": "The time of the last modification to the wish list", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "visibility", "description": "Indicates whether the wish list is public or private", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "WishlistVisibilityEnum", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "WishlistItem", "description": "", "fields": [ { "name": "added_at", "description": "The time when the customer added the item to the wish list", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": "The customer's comment about this item", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The unique ID for a `WishlistItem` object", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product", "description": null, "args": [], "type": { "kind": "INTERFACE", "name": "ProductInterface", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "qty", "description": "The quantity of this wish list item", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "WishlistItems", "description": "", "fields": [ { "name": "items", "description": "A list of items in the wish list", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "WishlistItemInterface", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "page_info", "description": "Contains pagination metadata", "args": [], "type": { "kind": "OBJECT", "name": "SearchResultPageInfo", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INTERFACE", "name": "WishlistItemInterface", "description": "", "fields": [ { "name": "added_at", "description": "The date and time the item was added to the wish list", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customizable_options", "description": "Custom options selected for the wish list item", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "SelectedCustomizableOption", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": "The description of the item", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The unique ID for a `WishlistItemInterface` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product", "description": "Product details of the wish list item", "args": [], "type": { "kind": "INTERFACE", "name": "ProductInterface", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity", "description": "The quantity of this wish list item", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "SimpleWishlistItem", "ofType": null }, { "kind": "OBJECT", "name": "VirtualWishlistItem", "ofType": null }, { "kind": "OBJECT", "name": "DownloadableWishlistItem", "ofType": null }, { "kind": "OBJECT", "name": "BundleWishlistItem", "ofType": null }, { "kind": "OBJECT", "name": "GroupedProductWishlistItem", "ofType": null }, { "kind": "OBJECT", "name": "ConfigurableWishlistItem", "ofType": null }, { "kind": "OBJECT", "name": "GiftCardWishlistItem", "ofType": null } ] }, { "kind": "OBJECT", "name": "SelectedCustomizableOption", "description": "", "fields": [ { "name": "customizable_option_uid", "description": "The unique ID for a `CustomizableRadioOption`, `CustomizableDropDownOption`, `CustomizableMultipleOption`, etc. of `CustomizableOptionInterface` objects", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use SelectedCustomizableOption.customizable_option_uid instead" }, { "name": "is_required", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "label", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "sort_order", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "type", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "values", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "SelectedCustomizableOptionValue", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SelectedCustomizableOptionValue", "description": "", "fields": [ { "name": "customizable_option_value_uid", "description": "The unique ID for a `CustomizableMultipleValue`, `CustomizableRadioValue`, `CustomizableCheckboxValue`, `CustomizableDropDownValue`, etc. objects", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use SelectedCustomizableOptionValue.customizable_option_value_uid instead" }, { "name": "label", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "price", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CartItemSelectedOptionValuePrice", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CartItemSelectedOptionValuePrice", "description": "", "fields": [ { "name": "type", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "PriceTypeEnum", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "units", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "PriceTypeEnum", "description": "This enumeration the price type.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "FIXED", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "PERCENT", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "DYNAMIC", "description": "", "isDeprecated": false, "deprecationReason": "" } ], "possibleTypes": null }, { "kind": "ENUM", "name": "WishlistVisibilityEnum", "description": "This enumeration defines the wish list visibility types", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "PUBLIC", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "PRIVATE", "description": "", "isDeprecated": false, "deprecationReason": "" } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerDownloadableProducts", "description": "", "fields": [ { "name": "items", "description": "List of purchased downloadable items", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "CustomerDownloadableProduct", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerDownloadableProduct", "description": "", "fields": [ { "name": "date", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "download_url", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "order_increment_id", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "remaining_downloads", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerPaymentTokens", "description": "", "fields": [ { "name": "items", "description": "An array of payment tokens", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "PaymentToken", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PaymentToken", "description": "The stored payment method available to the customer", "fields": [ { "name": "details", "description": "Stored account details", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "payment_method_code", "description": "The payment method code associated with the token", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "public_hash", "description": "The public hash of the token", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "type", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "PaymentTokenTypeEnum", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "PaymentTokenTypeEnum", "description": "The list of available payment token types", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "card", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "account", "description": "", "isDeprecated": false, "deprecationReason": "" } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "HostedProUrlInput", "description": "The required input to request the secure URL for Payments Pro Hosted Solution payment.", "fields": null, "inputFields": [ { "name": "cart_id", "description": "The unique ID that identifies the customer's cart", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "HostedProUrl", "description": "Contains secure URL used for Payments Pro Hosted Solution payment method.", "fields": [ { "name": "secure_form_url", "description": "Secure Url generated by PayPal", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "PayflowLinkTokenInput", "description": "Input required to fetch payment token information for Payflow Link and Payments Advanced payment methods.", "fields": null, "inputFields": [ { "name": "cart_id", "description": "The unique ID that identifies the customer's cart", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PayflowLinkToken", "description": "Contains information used to generate PayPal iframe for transaction. Applies to Payflow Link and Payments Advanced payment methods.", "fields": [ { "name": "mode", "description": "Mode for Payflow transaction", "args": [], "type": { "kind": "ENUM", "name": "PayflowLinkMode", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "paypal_url", "description": "PayPal URL used for requesting Payflow form", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "secure_token", "description": "Secure token generated by PayPal", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "secure_token_id", "description": "Secure token ID generated by PayPal", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "PayflowLinkMode", "description": "Mode for payment: TEST or LIVE. Applies to Payflow Link and Payments Advanced payment methods.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "TEST", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "LIVE", "description": "", "isDeprecated": false, "deprecationReason": "" } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "GiftCardAccountInput", "description": "", "fields": null, "inputFields": [ { "name": "gift_card_code", "description": "Defines the input required to identify the gift card account", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "GiftCardAccount", "description": "Contains details about the gift card account", "fields": [ { "name": "balance", "description": "Balance remaining on gift card", "args": [], "type": { "kind": "OBJECT", "name": "Money", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "code", "description": "Gift card account code", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "expiration_date", "description": "Gift card expiration date", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "IsEmailAvailableOutput", "description": "", "fields": [ { "name": "is_email_available", "description": "Is email availabel value", "args": [], "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "AreaInput", "description": "AreaInput defines the parameters which will be used for filter by specified location.", "fields": null, "inputFields": [ { "name": "radius", "description": "The radius for the search in KM.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "defaultValue": null }, { "name": "search_term", "description": "The country code where search must be performed. Required parameter together with region, city or postcode.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "PickupLocationFilterInput", "description": "PickupLocationFilterInput defines the list of attributes and filters for the search.", "fields": null, "inputFields": [ { "name": "city", "description": "Filter by city.", "type": { "kind": "INPUT_OBJECT", "name": "FilterTypeInput", "ofType": null }, "defaultValue": null }, { "name": "country_id", "description": "Filter by country.", "type": { "kind": "INPUT_OBJECT", "name": "FilterTypeInput", "ofType": null }, "defaultValue": null }, { "name": "name", "description": "Filter by pickup location name.", "type": { "kind": "INPUT_OBJECT", "name": "FilterTypeInput", "ofType": null }, "defaultValue": null }, { "name": "pickup_location_code", "description": "Filter by pickup location code.", "type": { "kind": "INPUT_OBJECT", "name": "FilterTypeInput", "ofType": null }, "defaultValue": null }, { "name": "postcode", "description": "Filter by postcode.", "type": { "kind": "INPUT_OBJECT", "name": "FilterTypeInput", "ofType": null }, "defaultValue": null }, { "name": "region", "description": "Filter by region.", "type": { "kind": "INPUT_OBJECT", "name": "FilterTypeInput", "ofType": null }, "defaultValue": null }, { "name": "region_id", "description": "Filter by region id.", "type": { "kind": "INPUT_OBJECT", "name": "FilterTypeInput", "ofType": null }, "defaultValue": null }, { "name": "street", "description": "Filter by street.", "type": { "kind": "INPUT_OBJECT", "name": "FilterTypeInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "FilterTypeInput", "description": "FilterTypeInput specifies which action will be performed in a query ", "fields": null, "inputFields": [ { "name": "eq", "description": "Equals", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "finset", "description": "", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "from", "description": "From. Must be used with 'to'", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "gt", "description": "Greater than", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "gteq", "description": "Greater than or equal to", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "in", "description": "In. The value can contain a set of comma-separated values", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "like", "description": "Like. The specified value can contain % (percent signs) to allow matching of 0 or more characters", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "lt", "description": "Less than", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "lteq", "description": "Less than or equal to", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "moreq", "description": "More than or equal to", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "neq", "description": "Not equal to", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "nin", "description": "Not in. The value can contain a set of comma-separated values", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "notnull", "description": "Not null", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "null", "description": "Is null", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "to", "description": "To. Must be used with 'from'", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "PickupLocationSortInput", "description": "PickupLocationSortInput specifies attribute to use for sorting search results and indicates whether the results are sorted in ascending or descending order.", "fields": null, "inputFields": [ { "name": "city", "description": "City where pickup location is placed.", "type": { "kind": "ENUM", "name": "SortEnum", "ofType": null }, "defaultValue": null }, { "name": "contact_name", "description": "Name of the contact person.", "type": { "kind": "ENUM", "name": "SortEnum", "ofType": null }, "defaultValue": null }, { "name": "country_id", "description": "Id of the country in two letters.", "type": { "kind": "ENUM", "name": "SortEnum", "ofType": null }, "defaultValue": null }, { "name": "description", "description": "Description of the pickup location.", "type": { "kind": "ENUM", "name": "SortEnum", "ofType": null }, "defaultValue": null }, { "name": "distance", "description": "Distance to the address, requested by distance filter. Applicable only with distance filter. If distance sort order is present, all other sort orders will be ignored.", "type": { "kind": "ENUM", "name": "SortEnum", "ofType": null }, "defaultValue": null }, { "name": "email", "description": "Contact email of the pickup location.", "type": { "kind": "ENUM", "name": "SortEnum", "ofType": null }, "defaultValue": null }, { "name": "fax", "description": "Contact fax of the pickup location.", "type": { "kind": "ENUM", "name": "SortEnum", "ofType": null }, "defaultValue": null }, { "name": "latitude", "description": "Geographic latitude where pickup location is placed.", "type": { "kind": "ENUM", "name": "SortEnum", "ofType": null }, "defaultValue": null }, { "name": "longitude", "description": "Geographic longitude where pickup location is placed.", "type": { "kind": "ENUM", "name": "SortEnum", "ofType": null }, "defaultValue": null }, { "name": "name", "description": "The pickup location name. Customer use this to identify the pickup location.", "type": { "kind": "ENUM", "name": "SortEnum", "ofType": null }, "defaultValue": null }, { "name": "phone", "description": "Contact phone number of the pickup location.", "type": { "kind": "ENUM", "name": "SortEnum", "ofType": null }, "defaultValue": null }, { "name": "pickup_location_code", "description": "A code assigned to pickup location to identify the source.", "type": { "kind": "ENUM", "name": "SortEnum", "ofType": null }, "defaultValue": null }, { "name": "postcode", "description": "Postcode where pickup location is placed.", "type": { "kind": "ENUM", "name": "SortEnum", "ofType": null }, "defaultValue": null }, { "name": "region", "description": "Name of the region.", "type": { "kind": "ENUM", "name": "SortEnum", "ofType": null }, "defaultValue": null }, { "name": "region_id", "description": "Id of the region.", "type": { "kind": "ENUM", "name": "SortEnum", "ofType": null }, "defaultValue": null }, { "name": "street", "description": "Street where pickup location is placed.", "type": { "kind": "ENUM", "name": "SortEnum", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ProductInfoInput", "description": "Product Information used for Pickup Locations search.", "fields": null, "inputFields": [ { "name": "sku", "description": "Product SKU.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PickupLocations", "description": "Top level object returned in a pickup locations search.", "fields": [ { "name": "items", "description": "An array of pickup locations that match the specific search request.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "PickupLocation", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "page_info", "description": "An object that includes the page_info and currentPage values specified in the query.", "args": [], "type": { "kind": "OBJECT", "name": "SearchResultPageInfo", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "total_count", "description": "The number of products returned.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PickupLocation", "description": "Defines Pickup Location information.", "fields": [ { "name": "city", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "contact_name", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "country_id", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "email", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fax", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "latitude", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "longitude", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "phone", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "pickup_location_code", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "postcode", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "region", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "region_id", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "street", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductReviewRatingsMetadata", "description": "", "fields": [ { "name": "items", "description": "List of product reviews sorted by position", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductReviewRatingMetadata", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductReviewRatingMetadata", "description": "", "fields": [ { "name": "id", "description": "An encoded rating ID.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The label assigned to an aspect of a product that is being rated, such as quality or price", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "values", "description": "List of product review ratings sorted by position.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductReviewRatingValueMetadata", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductReviewRatingValueMetadata", "description": "", "fields": [ { "name": "value", "description": "A ratings scale, such as the number of stars awarded", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "value_id", "description": "An encoded rating value id.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ProductAttributeFilterInput", "description": "ProductAttributeFilterInput 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.", "fields": null, "inputFields": [ { "name": "category_id", "description": "Deprecated: use `category_uid` to filter product by category id.", "type": { "kind": "INPUT_OBJECT", "name": "FilterEqualTypeInput", "ofType": null }, "defaultValue": null }, { "name": "category_uid", "description": "Filter product by the unique ID for a `CategoryInterface` object.", "type": { "kind": "INPUT_OBJECT", "name": "FilterEqualTypeInput", "ofType": null }, "defaultValue": null }, { "name": "description", "description": "Attribute label: Description", "type": { "kind": "INPUT_OBJECT", "name": "FilterMatchTypeInput", "ofType": null }, "defaultValue": null }, { "name": "fashion_color", "description": "Attribute label: Color", "type": { "kind": "INPUT_OBJECT", "name": "FilterEqualTypeInput", "ofType": null }, "defaultValue": null }, { "name": "fashion_material", "description": "Attribute label: Material", "type": { "kind": "INPUT_OBJECT", "name": "FilterEqualTypeInput", "ofType": null }, "defaultValue": null }, { "name": "fashion_size", "description": "Attribute label: Size", "type": { "kind": "INPUT_OBJECT", "name": "FilterEqualTypeInput", "ofType": null }, "defaultValue": null }, { "name": "fashion_style", "description": "Attribute label: Style", "type": { "kind": "INPUT_OBJECT", "name": "FilterEqualTypeInput", "ofType": null }, "defaultValue": null }, { "name": "format", "description": "Attribute label: Format", "type": { "kind": "INPUT_OBJECT", "name": "FilterEqualTypeInput", "ofType": null }, "defaultValue": null }, { "name": "has_video", "description": "Attribute label: Has Video", "type": { "kind": "INPUT_OBJECT", "name": "FilterEqualTypeInput", "ofType": null }, "defaultValue": null }, { "name": "name", "description": "Attribute label: Product Name", "type": { "kind": "INPUT_OBJECT", "name": "FilterMatchTypeInput", "ofType": null }, "defaultValue": null }, { "name": "price", "description": "Attribute label: Price", "type": { "kind": "INPUT_OBJECT", "name": "FilterRangeTypeInput", "ofType": null }, "defaultValue": null }, { "name": "short_description", "description": "Attribute label: Short Description", "type": { "kind": "INPUT_OBJECT", "name": "FilterMatchTypeInput", "ofType": null }, "defaultValue": null }, { "name": "sku", "description": "Attribute label: SKU", "type": { "kind": "INPUT_OBJECT", "name": "FilterEqualTypeInput", "ofType": null }, "defaultValue": null }, { "name": "url_key", "description": "The part of the URL that identifies the product", "type": { "kind": "INPUT_OBJECT", "name": "FilterEqualTypeInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "FilterRangeTypeInput", "description": "Defines a filter that matches a range of values, such as prices or dates.", "fields": null, "inputFields": [ { "name": "from", "description": "The beginning of the range", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "to", "description": "The end of the range", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "Products", "description": "The Products object is the top-level object returned in a product search.", "fields": [ { "name": "aggregations", "description": "Layered navigation aggregations.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "Aggregation", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "filters", "description": "Layered navigation filters array.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "LayerFilter", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use aggregations instead" }, { "name": "items", "description": "An array of products that match the specified search criteria.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "ProductInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "page_info", "description": "An object that includes the page_info and currentPage values specified in the query.", "args": [], "type": { "kind": "OBJECT", "name": "SearchResultPageInfo", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sort_fields", "description": "An object that includes the default sort field and all available sort fields.", "args": [], "type": { "kind": "OBJECT", "name": "SortFields", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "total_count", "description": "The number of products that are marked as visible. By default, in complex products, parent products are visible, but their child products are not.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "Aggregation", "description": "A bucket that contains information for each filterable option (such as price, category `UID`, and custom attributes).", "fields": [ { "name": "attribute_code", "description": "Attribute code of the aggregation group.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "count", "description": "The number of options in the aggregation group.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "label", "description": "The aggregation display name.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "options", "description": "Array of options for the aggregation.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "AggregationOption", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AggregationOption", "description": "", "fields": [ { "name": "count", "description": "The number of items that match the aggregation option.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "label", "description": "Aggregation option display label.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "The internal ID that represents the value of the option.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "AggregationOptionInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "INTERFACE", "name": "AggregationOptionInterface", "description": "", "fields": [ { "name": "count", "description": "The number of items that match the aggregation option.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "label", "description": "Aggregation option display label.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "The internal ID that represents the value of the option.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "AggregationOption", "ofType": null } ] }, { "kind": "OBJECT", "name": "LayerFilter", "description": "", "fields": [ { "name": "filter_items", "description": "Array of filter items.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "LayerFilterItemInterface", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use Aggregation.options instead." }, { "name": "filter_items_count", "description": "Count of filter items in filter group.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use Aggregation.count instead." }, { "name": "name", "description": "Layered navigation filter name.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use Aggregation.label instead." }, { "name": "request_var", "description": "Request variable name for filter query.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use Aggregation.attribute_code instead." } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INTERFACE", "name": "LayerFilterItemInterface", "description": "", "fields": [ { "name": "items_count", "description": "Count of items by filter.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use AggregationOption.count instead." }, { "name": "label", "description": "Filter label.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use AggregationOption.label instead." }, { "name": "value_string", "description": "Value for filter request variable to be used in query.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use AggregationOption.value instead." } ], "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "LayerFilterItem", "ofType": null }, { "kind": "OBJECT", "name": "SwatchLayerFilterItem", "ofType": null } ] }, { "kind": "OBJECT", "name": "SortFields", "description": "SortFields contains a default value for sort fields and all available sort fields.", "fields": [ { "name": "default", "description": "Default value of sort fields.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "options", "description": "Available sort fields.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "SortField", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SortField", "description": "", "fields": [ { "name": "label", "description": "Label of sort field.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "Attribute code of sort field.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "EntityUrl", "description": "EntityUrl is an output object containing the `id`, `relative_url`, and `type` attributes", "fields": [ { "name": "canonical_url", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "The canonical_url field is deprecated, use relative_url instead." }, { "name": "entity_uid", "description": "The unique ID for a `ProductInterface`, `CategoryInterface`, `CmsPage`, etc. object associated with the specified url. This could be a product UID, category UID, or cms page UID.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The ID assigned to the object associated with the specified url. This could be a product ID, category ID, or page ID.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `entity_uid` instead." }, { "name": "redirectCode", "description": "301 or 302 HTTP code for url permanent or temporary redirect or 0 for the 200 no redirect", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "relative_url", "description": "The internal relative URL. If the specified url is a redirect, the query returns the redirected URL, not the original.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "type", "description": "One of PRODUCT, CATEGORY, or CMS_PAGE.", "args": [], "type": { "kind": "ENUM", "name": "UrlRewriteEntityTypeEnum", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "UrlRewriteEntityTypeEnum", "description": "This enumeration defines the entity type.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "CMS_PAGE", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "PRODUCT", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "CATEGORY", "description": "", "isDeprecated": false, "deprecationReason": "" } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "WishlistOutput", "description": "Deprecated: `Wishlist` type should be used instead", "fields": [ { "name": "items", "description": "An array of items in the customer's wish list", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "WishlistItem", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use field `items` from type `Wishlist` instead" }, { "name": "items_count", "description": "The number of items in the wish list", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use field `items_count` from type `Wishlist` instead" }, { "name": "name", "description": "When multiple wish lists are enabled, the name the customer assigns to the wishlist", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "This field is related to Commerce functionality and is always `null` in Open Source edition" }, { "name": "sharing_code", "description": "An encrypted code that Magento uses to link to the wish list", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use field `sharing_code` from type `Wishlist` instead" }, { "name": "updated_at", "description": "The time of the last modification to the wish list", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use field `updated_at` from type `Wishlist` instead" } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "Mutation", "description": "", "fields": [ { "name": "addBundleProductsToCart", "description": null, "args": [ { "name": "input", "description": "", "type": { "kind": "INPUT_OBJECT", "name": "AddBundleProductsToCartInput", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "AddBundleProductsToCartOutput", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "addConfigurableProductsToCart", "description": null, "args": [ { "name": "input", "description": "", "type": { "kind": "INPUT_OBJECT", "name": "AddConfigurableProductsToCartInput", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "AddConfigurableProductsToCartOutput", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "addDownloadableProductsToCart", "description": null, "args": [ { "name": "input", "description": "", "type": { "kind": "INPUT_OBJECT", "name": "AddDownloadableProductsToCartInput", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "AddDownloadableProductsToCartOutput", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "addProductsToCart", "description": "Add any type of product to the cart", "args": [ { "name": "cartId", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "cartItems", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CartItemInput", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "AddProductsToCartOutput", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "addProductsToCompareList", "description": "Add products to the specified compare list", "args": [ { "name": "input", "description": "", "type": { "kind": "INPUT_OBJECT", "name": "AddProductsToCompareListInput", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CompareList", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "addProductsToWishlist", "description": "Adds one or more products to the specified wish list. This mutation supports all product types", "args": [ { "name": "wishlistId", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "wishlistItems", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "WishlistItemInput", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "AddProductsToWishlistOutput", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "addReturnComment", "description": "Add a comment to an existing return", "args": [ { "name": "input", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "AddReturnCommentInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "AddReturnCommentOutput", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "addReturnTracking", "description": "Add tracking information to the return", "args": [ { "name": "input", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "AddReturnTrackingInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "AddReturnTrackingOutput", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "addSimpleProductsToCart", "description": null, "args": [ { "name": "input", "description": "", "type": { "kind": "INPUT_OBJECT", "name": "AddSimpleProductsToCartInput", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "AddSimpleProductsToCartOutput", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "addVirtualProductsToCart", "description": null, "args": [ { "name": "input", "description": "", "type": { "kind": "INPUT_OBJECT", "name": "AddVirtualProductsToCartInput", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "AddVirtualProductsToCartOutput", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "applyCouponToCart", "description": null, "args": [ { "name": "input", "description": "", "type": { "kind": "INPUT_OBJECT", "name": "ApplyCouponToCartInput", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ApplyCouponToCartOutput", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "applyGiftCardToCart", "description": "Apply a pre-defined gift card code to the specified cart.", "args": [ { "name": "input", "description": "", "type": { "kind": "INPUT_OBJECT", "name": "ApplyGiftCardToCartInput", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ApplyGiftCardToCartOutput", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "applyRewardPointsToCart", "description": "Apply all available points, up to the cart total. Partial redemption is not available", "args": [ { "name": "cartId", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ApplyRewardPointsToCartOutput", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "applyStoreCreditToCart", "description": "Apply store credit to the specified cart.", "args": [ { "name": "input", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "ApplyStoreCreditToCartInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ApplyStoreCreditToCartOutput", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "assignCompareListToCustomer", "description": "Assign the specified compare list to the logged in customer", "args": [ { "name": "uid", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "AssignCompareListToCustomerOutput", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "changeCustomerPassword", "description": "Changes the password for the logged-in customer", "args": [ { "name": "currentPassword", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "newPassword", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "Customer", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "copyProductsBetweenWishlists", "description": "Copy products from one wish list to another", "args": [ { "name": "sourceWishlistUid", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "destinationWishlistUid", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "wishlistItems", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "WishlistItemCopyInput", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CopyProductsBetweenWishlistsOutput", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "createBraintreeClientToken", "description": "Creates Client Token for Braintree Javascript SDK initialization.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "createCompareList", "description": "Creates a new compare list. The compare list is saved for logged in customers", "args": [ { "name": "input", "description": "", "type": { "kind": "INPUT_OBJECT", "name": "CreateCompareListInput", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CompareList", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "createCustomer", "description": "Create customer account", "args": [ { "name": "input", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CustomerInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CustomerOutput", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "createCustomerAddress", "description": "Create customer address", "args": [ { "name": "input", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CustomerAddressInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CustomerAddress", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "createCustomerV2", "description": "Create customer account", "args": [ { "name": "input", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CustomerCreateInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CustomerOutput", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "createEmptyCart", "description": "Creates an empty shopping cart for a guest or logged in user", "args": [ { "name": "input", "description": "", "type": { "kind": "INPUT_OBJECT", "name": "createEmptyCartInput", "ofType": null }, "defaultValue": null } ], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "createKlarnaPaymentsSession", "description": "Creates a Klarna Payments Session.", "args": [ { "name": "input", "description": "", "type": { "kind": "INPUT_OBJECT", "name": "createKlarnaPaymentsSessionInput", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "createKlarnaPaymentsSessionOutput", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "createPayflowProToken", "description": "Initiates a transaction and receives a token. Use this mutation for Payflow Pro and Payments Pro payment methods", "args": [ { "name": "input", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "PayflowProTokenInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CreatePayflowProTokenOutput", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "createPaypalExpressToken", "description": "Initiates an Express Checkout transaction and receives a token. Use this mutation for Express Checkout and Payments Standard payment methods.", "args": [ { "name": "input", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "PaypalExpressTokenInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PaypalExpressTokenOutput", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "createProductReview", "description": "Creates a product review for the specified SKU", "args": [ { "name": "input", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CreateProductReviewInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "CreateProductReviewOutput", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "createWishlist", "description": "Create a new wish list", "args": [ { "name": "input", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CreateWishlistInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CreateWishlistOutput", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "deleteCompareList", "description": "Delete the specified compare list", "args": [ { "name": "uid", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DeleteCompareListOutput", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "deleteCustomerAddress", "description": "Delete customer address", "args": [ { "name": "id", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "deletePaymentToken", "description": "Delete a customer payment token", "args": [ { "name": "public_hash", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DeletePaymentTokenOutput", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "deleteWishlist", "description": "Delete the specified wish list filtered by the unique ID for a `Wishlist` object", "args": [ { "name": "wishlistId", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "DeleteWishlistOutput", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "generateCustomerToken", "description": "Retrieve the customer token", "args": [ { "name": "email", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "password", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CustomerToken", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "generateCustomerTokenAsAdmin", "description": "Request a customer token so that an administrator can perform remote shopping assistance", "args": [ { "name": "input", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "GenerateCustomerTokenAsAdminInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "GenerateCustomerTokenAsAdminOutput", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "handlePayflowProResponse", "description": "Handles payment response and saves payment in Quote. Use this mutations for Payflow Pro and Payments Pro payment methods.", "args": [ { "name": "input", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "PayflowProResponseInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PayflowProResponseOutput", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "mergeCarts", "description": "Merges the source cart into the destination cart", "args": [ { "name": "source_cart_id", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "destination_cart_id", "description": "", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Cart", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "moveProductsBetweenWishlists", "description": "Move products from one wish list to another", "args": [ { "name": "sourceWishlistUid", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "destinationWishlistUid", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "wishlistItems", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "WishlistItemMoveInput", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "MoveProductsBetweenWishlistsOutput", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "placeOrder", "description": null, "args": [ { "name": "input", "description": "", "type": { "kind": "INPUT_OBJECT", "name": "PlaceOrderInput", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PlaceOrderOutput", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "redeemGiftCardBalanceAsStoreCredit", "description": "Redeem gift card for store credit.", "args": [ { "name": "input", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "GiftCardAccountInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "GiftCardAccount", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "removeCouponFromCart", "description": null, "args": [ { "name": "input", "description": "", "type": { "kind": "INPUT_OBJECT", "name": "RemoveCouponFromCartInput", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "RemoveCouponFromCartOutput", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "removeGiftCardFromCart", "description": null, "args": [ { "name": "input", "description": "", "type": { "kind": "INPUT_OBJECT", "name": "RemoveGiftCardFromCartInput", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "RemoveGiftCardFromCartOutput", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "removeItemFromCart", "description": null, "args": [ { "name": "input", "description": "", "type": { "kind": "INPUT_OBJECT", "name": "RemoveItemFromCartInput", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "RemoveItemFromCartOutput", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "removeProductsFromCompareList", "description": "Remove products from the specified compare list", "args": [ { "name": "input", "description": "", "type": { "kind": "INPUT_OBJECT", "name": "RemoveProductsFromCompareListInput", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CompareList", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "removeProductsFromWishlist", "description": "Removes one or more products from the specified wish list", "args": [ { "name": "wishlistId", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "wishlistItemsIds", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "RemoveProductsFromWishlistOutput", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "removeReturnTracking", "description": "Remove a tracked shipment from a return", "args": [ { "name": "input", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "RemoveReturnTrackingInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "RemoveReturnTrackingOutput", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "removeRewardPointsFromCart", "description": "Cancel the application of reward points to the cart", "args": [ { "name": "cartId", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "RemoveRewardPointsFromCartOutput", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "removeStoreCreditFromCart", "description": "Remove applied store credit from the specified cart.", "args": [ { "name": "input", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "RemoveStoreCreditFromCartInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "RemoveStoreCreditFromCartOutput", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "reorderItems", "description": "Adds all products from a customer's previous order to the cart.", "args": [ { "name": "orderNumber", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ReorderItemsOutput", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "requestPasswordResetEmail", "description": "Request an email with a reset password token for the registered customer identified by the specified email.", "args": [ { "name": "email", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "requestReturn", "description": "Initiates a buyer's request to return an item for replacement or refund", "args": [ { "name": "input", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "RequestReturnInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "RequestReturnOutput", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "resetPassword", "description": "Reset a customer's password using the reset password token that the customer received in an email after requesting it using requestPasswordResetEmail.", "args": [ { "name": "email", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "resetPasswordToken", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "newPassword", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "revokeCustomerToken", "description": "Revoke the customer token", "args": [], "type": { "kind": "OBJECT", "name": "RevokeCustomerTokenOutput", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sendEmailToFriend", "description": "Recommends Product by Sending Single/Multiple Email", "args": [ { "name": "input", "description": "", "type": { "kind": "INPUT_OBJECT", "name": "SendEmailToFriendInput", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SendEmailToFriendOutput", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "setBillingAddressOnCart", "description": null, "args": [ { "name": "input", "description": "", "type": { "kind": "INPUT_OBJECT", "name": "SetBillingAddressOnCartInput", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SetBillingAddressOnCartOutput", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "setGiftOptionsOnCart", "description": "Set gift options like gift wrapping or gift message for the entire cart", "args": [ { "name": "input", "description": "", "type": { "kind": "INPUT_OBJECT", "name": "SetGiftOptionsOnCartInput", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SetGiftOptionsOnCartOutput", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "setGuestEmailOnCart", "description": null, "args": [ { "name": "input", "description": "", "type": { "kind": "INPUT_OBJECT", "name": "SetGuestEmailOnCartInput", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SetGuestEmailOnCartOutput", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "setPaymentMethodAndPlaceOrder", "description": null, "args": [ { "name": "input", "description": "", "type": { "kind": "INPUT_OBJECT", "name": "SetPaymentMethodAndPlaceOrderInput", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "PlaceOrderOutput", "ofType": null }, "isDeprecated": true, "deprecationReason": "Should use setPaymentMethodOnCart and placeOrder mutations in single request." }, { "name": "setPaymentMethodOnCart", "description": null, "args": [ { "name": "input", "description": "", "type": { "kind": "INPUT_OBJECT", "name": "SetPaymentMethodOnCartInput", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SetPaymentMethodOnCartOutput", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "setShippingAddressesOnCart", "description": null, "args": [ { "name": "input", "description": "", "type": { "kind": "INPUT_OBJECT", "name": "SetShippingAddressesOnCartInput", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SetShippingAddressesOnCartOutput", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "setShippingMethodsOnCart", "description": null, "args": [ { "name": "input", "description": "", "type": { "kind": "INPUT_OBJECT", "name": "SetShippingMethodsOnCartInput", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SetShippingMethodsOnCartOutput", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "subscribeEmailToNewsletter", "description": "Subscribes the specified email to a newsletter", "args": [ { "name": "email", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "SubscribeEmailToNewsletterOutput", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "updateCartItems", "description": null, "args": [ { "name": "input", "description": "", "type": { "kind": "INPUT_OBJECT", "name": "UpdateCartItemsInput", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "UpdateCartItemsOutput", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "updateCustomer", "description": "Deprecated. Use UpdateCustomerV2 instead.", "args": [ { "name": "input", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CustomerInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CustomerOutput", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "updateCustomerAddress", "description": "Update customer address", "args": [ { "name": "id", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "defaultValue": null }, { "name": "input", "description": "", "type": { "kind": "INPUT_OBJECT", "name": "CustomerAddressInput", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CustomerAddress", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "updateCustomerEmail", "description": null, "args": [ { "name": "email", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "password", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CustomerOutput", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "updateCustomerV2", "description": "Update the customer's personal information", "args": [ { "name": "input", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CustomerUpdateInput", "ofType": null } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "CustomerOutput", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "updateProductsInWishlist", "description": "Updates one or more products in the specified wish list", "args": [ { "name": "wishlistId", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "wishlistItems", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "WishlistItemUpdateInput", "ofType": null } } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "UpdateProductsInWishlistOutput", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "updateWishlist", "description": "Change the name and visibility of the specified wish list", "args": [ { "name": "wishlistId", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "name", "description": "", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "visibility", "description": "", "type": { "kind": "ENUM", "name": "WishlistVisibilityEnum", "ofType": null }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "UpdateWishlistOutput", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "AddBundleProductsToCartInput", "description": "", "fields": null, "inputFields": [ { "name": "cart_id", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "cart_items", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "BundleProductCartItemInput", "ofType": null } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "BundleProductCartItemInput", "description": "", "fields": null, "inputFields": [ { "name": "bundle_options", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "BundleOptionInput", "ofType": null } } }, "defaultValue": null }, { "name": "customizable_options", "description": "", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CustomizableOptionInput", "ofType": null } }, "defaultValue": null }, { "name": "data", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CartItemInput", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "BundleOptionInput", "description": "", "fields": null, "inputFields": [ { "name": "id", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "defaultValue": null }, { "name": "quantity", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "defaultValue": null }, { "name": "value", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CustomizableOptionInput", "description": "", "fields": null, "inputFields": [ { "name": "id", "description": "The customizable option id of the product", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "value_string", "description": "The string value of the option", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CartItemInput", "description": "", "fields": null, "inputFields": [ { "name": "entered_options", "description": "An array of entered options for the base product, such as personalization text", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "EnteredOptionInput", "ofType": null } }, "defaultValue": null }, { "name": "parent_sku", "description": "For child products, the SKU of its parent product", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "quantity", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "defaultValue": null }, { "name": "selected_options", "description": "The selected options for the base product, such as color or size with unique ID for a `CustomizableRadioOption`, `CustomizableDropDownOption`, `ConfigurableProductOptionsValues`, etc. objects", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "sku", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "EnteredOptionInput", "description": "Defines a customer-entered option", "fields": null, "inputFields": [ { "name": "uid", "description": "The unique ID for a `CustomizableFieldOption`, `CustomizableFileOption`, `CustomizableAreaOption`, etc. of `CustomizableOptionInterface` objects", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "value", "description": "Text the customer entered", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AddBundleProductsToCartOutput", "description": "", "fields": [ { "name": "cart", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Cart", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "AddConfigurableProductsToCartInput", "description": "", "fields": null, "inputFields": [ { "name": "cart_id", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "cart_items", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "ConfigurableProductCartItemInput", "ofType": null } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ConfigurableProductCartItemInput", "description": "", "fields": null, "inputFields": [ { "name": "customizable_options", "description": "", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CustomizableOptionInput", "ofType": null } }, "defaultValue": null }, { "name": "data", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CartItemInput", "ofType": null } }, "defaultValue": null }, { "name": "parent_sku", "description": "Configurable product SKU.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "variant_sku", "description": "Deprecated. Use CartItemInput.sku instead.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AddConfigurableProductsToCartOutput", "description": "", "fields": [ { "name": "cart", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Cart", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "AddDownloadableProductsToCartInput", "description": "", "fields": null, "inputFields": [ { "name": "cart_id", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "cart_items", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "DownloadableProductCartItemInput", "ofType": null } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "DownloadableProductCartItemInput", "description": "", "fields": null, "inputFields": [ { "name": "customizable_options", "description": "", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CustomizableOptionInput", "ofType": null } }, "defaultValue": null }, { "name": "data", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CartItemInput", "ofType": null } }, "defaultValue": null }, { "name": "downloadable_product_links", "description": "", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "DownloadableProductLinksInput", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "DownloadableProductLinksInput", "description": "", "fields": null, "inputFields": [ { "name": "link_id", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AddDownloadableProductsToCartOutput", "description": "", "fields": [ { "name": "cart", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Cart", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AddProductsToCartOutput", "description": "", "fields": [ { "name": "cart", "description": "The cart after products have been added", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Cart", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "user_errors", "description": "An error encountered while adding an item to the cart.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "CartUserInputError", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CartUserInputError", "description": "An error encountered while adding an item to the the cart.", "fields": [ { "name": "code", "description": "Cart-specific error code", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CartUserInputErrorType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "A localized error message", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CartUserInputErrorType", "description": "", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "PRODUCT_NOT_FOUND", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "NOT_SALABLE", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "INSUFFICIENT_STOCK", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "UNDEFINED", "description": "", "isDeprecated": false, "deprecationReason": "" } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "AddProductsToCompareListInput", "description": "", "fields": null, "inputFields": [ { "name": "products", "description": "An array of product IDs to add to the compare list", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null }, { "name": "uid", "description": "The unique identifier of the compare list to modify", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "WishlistItemInput", "description": "Defines the items to add to a wish list", "fields": null, "inputFields": [ { "name": "entered_options", "description": "An array of options that the customer entered", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "EnteredOptionInput", "ofType": null } }, "defaultValue": null }, { "name": "parent_sku", "description": "For complex product types, the SKU of the parent product", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "quantity", "description": "The amount or number of items to add", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "defaultValue": null }, { "name": "selected_options", "description": "An array of strings corresponding to options the customer selected", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "sku", "description": "The SKU of the product to add. For complex product types, specify the child product SKU", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AddProductsToWishlistOutput", "description": "Contains the customer's wish list and any errors encountered", "fields": [ { "name": "user_errors", "description": "An array of errors encountered while adding products to a wish list", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "WishListUserInputError", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "wishlist", "description": "Contains the wish list with all items that were successfully added", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Wishlist", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "WishListUserInputError", "description": "An error encountered while performing operations with WishList.", "fields": [ { "name": "code", "description": "Wishlist-specific error code", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "WishListUserInputErrorType", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "A localized error message", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "WishListUserInputErrorType", "description": "", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "PRODUCT_NOT_FOUND", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "UNDEFINED", "description": "", "isDeprecated": false, "deprecationReason": "" } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "AddReturnCommentInput", "description": "", "fields": null, "inputFields": [ { "name": "comment_text", "description": "The text added to the return request", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "return_uid", "description": "The unique ID for a `Return` object", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AddReturnCommentOutput", "description": "", "fields": [ { "name": "return", "description": "Contains details about the modified return", "args": [], "type": { "kind": "OBJECT", "name": "Return", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "AddReturnTrackingInput", "description": "", "fields": null, "inputFields": [ { "name": "carrier_uid", "description": "The unique ID for a `ReturnShippingCarrier` object", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "return_uid", "description": "The unique ID for a `Returns` object", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "tracking_number", "description": "The shipping tracking number for this return request", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AddReturnTrackingOutput", "description": "", "fields": [ { "name": "return", "description": "Contains details about the modified return", "args": [], "type": { "kind": "OBJECT", "name": "Return", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "return_shipping_tracking", "description": "Contains details about shipping for a return", "args": [], "type": { "kind": "OBJECT", "name": "ReturnShippingTracking", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "AddSimpleProductsToCartInput", "description": "", "fields": null, "inputFields": [ { "name": "cart_id", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "cart_items", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "SimpleProductCartItemInput", "ofType": null } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SimpleProductCartItemInput", "description": "", "fields": null, "inputFields": [ { "name": "customizable_options", "description": "", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CustomizableOptionInput", "ofType": null } }, "defaultValue": null }, { "name": "data", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CartItemInput", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AddSimpleProductsToCartOutput", "description": "", "fields": [ { "name": "cart", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Cart", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "AddVirtualProductsToCartInput", "description": "", "fields": null, "inputFields": [ { "name": "cart_id", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "cart_items", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "VirtualProductCartItemInput", "ofType": null } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "VirtualProductCartItemInput", "description": "", "fields": null, "inputFields": [ { "name": "customizable_options", "description": "", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CustomizableOptionInput", "ofType": null } }, "defaultValue": null }, { "name": "data", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CartItemInput", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AddVirtualProductsToCartOutput", "description": "", "fields": [ { "name": "cart", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Cart", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ApplyCouponToCartInput", "description": "", "fields": null, "inputFields": [ { "name": "cart_id", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "coupon_code", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ApplyCouponToCartOutput", "description": "", "fields": [ { "name": "cart", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Cart", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ApplyGiftCardToCartInput", "description": "Defines the input required to run the applyGiftCardToCart mutation", "fields": null, "inputFields": [ { "name": "cart_id", "description": "The unique ID that identifies the customer's cart", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "gift_card_code", "description": "The gift card code to be applied to the cart", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ApplyGiftCardToCartOutput", "description": "Defines the possible output for the applyGiftCardToCart mutation", "fields": [ { "name": "cart", "description": "Describes the contents of the specified shopping cart", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Cart", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ApplyRewardPointsToCartOutput", "description": "", "fields": [ { "name": "cart", "description": "The customer cart after reward points are applied", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Cart", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ApplyStoreCreditToCartInput", "description": "Defines the input required to run the applyStoreCreditToCart mutation", "fields": null, "inputFields": [ { "name": "cart_id", "description": "The unique ID that identifies the customer's cart", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ApplyStoreCreditToCartOutput", "description": "Defines the possible output for the applyStoreCreditToCart mutation", "fields": [ { "name": "cart", "description": "Describes the contents of the specified shopping cart", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Cart", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "AssignCompareListToCustomerOutput", "description": "", "fields": [ { "name": "compare_list", "description": "The contents of the customer's compare list", "args": [], "type": { "kind": "OBJECT", "name": "CompareList", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "result", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "WishlistItemCopyInput", "description": "", "fields": null, "inputFields": [ { "name": "quantity", "description": "The quantity of this item to copy to the destination wish list. This value can't be greater than the quantity in the source wish list.", "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "defaultValue": null }, { "name": "wishlist_item_id", "description": "The unique ID for a `WishlistItemInterface` object to be copied", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CopyProductsBetweenWishlistsOutput", "description": "", "fields": [ { "name": "destination_wishlist", "description": "The destination wish list containing the copied products", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Wishlist", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "source_wishlist", "description": "The wish list that the products were copied from", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Wishlist", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "user_errors", "description": "An array of errors encountered while copying products in a wish list", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "WishListUserInputError", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CreateCompareListInput", "description": "", "fields": null, "inputFields": [ { "name": "products", "description": "An array of product IDs to add to the compare list", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CustomerInput", "description": "", "fields": null, "inputFields": [ { "name": "date_of_birth", "description": "The customer's date of birth", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "dob", "description": "Deprecated: Use `date_of_birth` instead", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "email", "description": "The customer's email address. Required for customer creation", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "firstname", "description": "The customer's first name", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "gender", "description": "The customer's gender (Male - 1, Female - 2)", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "is_subscribed", "description": "Indicates whether the customer is subscribed to the company's newsletter", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "lastname", "description": "The customer's family name", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "middlename", "description": "The customer's middle name", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "password", "description": "The customer's password", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "prefix", "description": "An honorific, such as Dr., Mr., or Mrs.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "suffix", "description": "A value such as Sr., Jr., or III", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "taxvat", "description": "The customer's Tax/VAT number (for corporate customers)", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerOutput", "description": "", "fields": [ { "name": "customer", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Customer", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CustomerAddressInput", "description": "", "fields": null, "inputFields": [ { "name": "city", "description": "The city or town", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "company", "description": "The customer's company", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "country_code", "description": "The customer's country", "type": { "kind": "ENUM", "name": "CountryCodeEnum", "ofType": null }, "defaultValue": null }, { "name": "country_id", "description": "Deprecated: use `country_code` instead.", "type": { "kind": "ENUM", "name": "CountryCodeEnum", "ofType": null }, "defaultValue": null }, { "name": "custom_attributes", "description": "Deprecated: Custom attributes should not be put into container.", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CustomerAddressAttributeInput", "ofType": null } }, "defaultValue": null }, { "name": "default_billing", "description": "Indicates whether the address is the default billing address", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "default_shipping", "description": "Indicates whether the address is the default shipping address", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "fax", "description": "The fax number", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "firstname", "description": "The first name of the person associated with the shipping/billing address", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "lastname", "description": "The family name of the person associated with the shipping/billing address", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "middlename", "description": "The middle name of the person associated with the shipping/billing address", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "postcode", "description": "The customer's ZIP or postal code", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "prefix", "description": "An honorific, such as Dr., Mr., or Mrs.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "region", "description": "An object containing the region name, region code, and region ID", "type": { "kind": "INPUT_OBJECT", "name": "CustomerAddressRegionInput", "ofType": null }, "defaultValue": null }, { "name": "street", "description": "An array of strings that define the street number and name", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "suffix", "description": "A value such as Sr., Jr., or III", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "telephone", "description": "The telephone number", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "vat_id", "description": "The customer's Tax/VAT number (for corporate customers)", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CustomerAddressAttributeInput", "description": "", "fields": null, "inputFields": [ { "name": "attribute_code", "description": "Attribute code", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "value", "description": "Attribute value", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CustomerAddressRegionInput", "description": "CustomerAddressRegionInput defines the customer's state or province", "fields": null, "inputFields": [ { "name": "region", "description": "The state or province name", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "region_code", "description": "The address region code", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "region_id", "description": "The unique ID for a pre-defined region", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CustomerCreateInput", "description": "", "fields": null, "inputFields": [ { "name": "allow_remote_shopping_assistance", "description": "Indicates whether the customer has enabled remote shopping assistance", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "date_of_birth", "description": "The customer's date of birth", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "dob", "description": "Deprecated: Use `date_of_birth` instead", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "email", "description": "The customer's email address. Required for customer creation", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "firstname", "description": "The customer's first name", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "gender", "description": "The customer's gender (Male - 1, Female - 2)", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "is_subscribed", "description": "Indicates whether the customer is subscribed to the company's newsletter", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "lastname", "description": "The customer's family name", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "middlename", "description": "The customer's middle name", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "password", "description": "The customer's password", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "prefix", "description": "An honorific, such as Dr., Mr., or Mrs.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "suffix", "description": "A value such as Sr., Jr., or III", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "taxvat", "description": "The customer's Tax/VAT number (for corporate customers)", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "createEmptyCartInput", "description": "", "fields": null, "inputFields": [ { "name": "cart_id", "description": "", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "createKlarnaPaymentsSessionInput", "description": "", "fields": null, "inputFields": [ { "name": "cart_id", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "createKlarnaPaymentsSessionOutput", "description": "", "fields": [ { "name": "client_token", "description": "The payment method client token", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "payment_method_categories", "description": "The payment method categories", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "Categories", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "Categories", "description": "", "fields": [ { "name": "asset_urls", "description": "The payment method assets", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "Assets", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "identifier", "description": "The payment method identifier", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The payment method name", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "Assets", "description": "", "fields": [ { "name": "descriptive", "description": "The payment method logo url (descriptive)", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "standard", "description": "The payment method logo url (standard)", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "PayflowProTokenInput", "description": "Input required to fetch payment token information for Payflow Pro and Payments Pro payment methods.", "fields": null, "inputFields": [ { "name": "cart_id", "description": "The unique ID that identifies the customer's cart", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "urls", "description": "A set of relative URLs that PayPal uses for callback.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "PayflowProUrlInput", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "PayflowProUrlInput", "description": "A set of relative URLs that PayPal will use in response to various actions during the authorization process. Magento prepends the base URL to this value to create a full URL. For example, if the full URL is https://www.example.com/path/to/page.html, the relative URL is path/to/page.html. Use this input for Payflow Pro and Payment Pro payment methods.", "fields": null, "inputFields": [ { "name": "cancel_url", "description": "The relative URL of the page that PayPal will redirect to when the buyer cancels the transaction in order to choose a different payment method. If the full URL to this page is https://www.example.com/paypal/action/cancel.html, the relative URL is paypal/action/cancel.html.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "error_url", "description": "The relative URL of the transaction error page that PayPal will redirect to upon payment error. If the full URL to this page is https://www.example.com/paypal/action/error.html, the relative URL is paypal/action/error.html.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "return_url", "description": "The relative URL of the final confirmation page that PayPal will redirect to upon payment success. If the full URL to this page is https://www.example.com/paypal/action/return.html, the relative URL is paypal/action/return.html.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CreatePayflowProTokenOutput", "description": "Contains the secure information used to authorize transaction. Applies to Payflow Pro and Payments Pro payment methods.", "fields": [ { "name": "response_message", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "result", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "result_code", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "secure_token", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "secure_token_id", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "PaypalExpressTokenInput", "description": "Defines the attributes required to receive a payment token for Express Checkout and Payments Standard payment methods.", "fields": null, "inputFields": [ { "name": "cart_id", "description": "The unique ID that identifies the customer's cart", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "code", "description": "Payment method code", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "express_button", "description": "Indicates whether the buyer selected the quick checkout button. The default value is false", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "urls", "description": "A set of relative URLs that PayPal uses in response to various actions during the authorization process", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "PaypalExpressUrlsInput", "ofType": null } }, "defaultValue": null }, { "name": "use_paypal_credit", "description": "Indicates whether the buyer clicked the PayPal credit button. The default value is false", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "PaypalExpressUrlsInput", "description": "A set of relative URLs that PayPal will use in response to various actions during the authorization process. Magento prepends the base URL to this value to create a full URL. For example, if the full URL is https://www.example.com/path/to/page.html, the relative URL is path/to/page.html. Use this input for Express Checkout and Payments Standard payment methods.", "fields": null, "inputFields": [ { "name": "cancel_url", "description": "The relative URL of the page that PayPal will redirect to when the buyer cancels the transaction in order to choose a different payment method. If the full URL to this page is https://www.example.com/paypal/action/cancel.html, the relative URL is paypal/action/cancel.html.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "pending_url", "description": "The relative URL of the page that PayPal will redirect to when the payment has been put on hold for additional review. This condition mostly applies to ACH transactions, and is not applicable to most PayPal solutions. If the full URL to this page is https://www.example.com/paypal/action/success_pending.html, the relative URL is paypal/action/success_pending.html. ", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "return_url", "description": "The relative URL of the final confirmation page that PayPal will redirect to upon payment success. If the full URL to this page is https://www.example.com/paypal/action/return.html, the relative URL is paypal/action/return.html.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "success_url", "description": "The relative URL of the order confirmation page that PayPal will redirect to when the payment is successful and additional confirmation is not needed. Not applicable to most PayPal solutions. If the full URL to this page is https://www.example.com/paypal/action/success.html, the relative URL is paypal/action/success.html.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PaypalExpressTokenOutput", "description": "Contains the token returned by PayPal and a set of URLs that allow the buyer to authorize payment and adjust checkout details. Applies to Express Checkout and Payments Standard payment methods.", "fields": [ { "name": "paypal_urls", "description": "A set of URLs that allow the buyer to authorize payment and adjust checkout details", "args": [], "type": { "kind": "OBJECT", "name": "PaypalExpressUrlList", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "token", "description": "The token returned by PayPal", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PaypalExpressUrlList", "description": "A set of URLs that allow the buyer to authorize payment and adjust checkout details for Express Checkout and Payments Standard transactions.", "fields": [ { "name": "edit", "description": "The PayPal URL that allows the buyer to edit their checkout details", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "start", "description": "The URL to the PayPal login page", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CreateProductReviewInput", "description": "", "fields": null, "inputFields": [ { "name": "nickname", "description": "The customer's nickname. Defaults to the customer name, if logged in", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "ratings", "description": "Ratings details by category. e.g price: 5, quality: 4 etc", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "ProductReviewRatingInput", "ofType": null } } }, "defaultValue": null }, { "name": "sku", "description": "The SKU of the reviewed product", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "summary", "description": "The summary (title) of the review", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "text", "description": "The review text.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ProductReviewRatingInput", "description": "", "fields": null, "inputFields": [ { "name": "id", "description": "An encoded rating ID.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "value_id", "description": "An encoded rating value id.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CreateProductReviewOutput", "description": "", "fields": [ { "name": "review", "description": "Contains the completed product review", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductReview", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CreateWishlistInput", "description": "", "fields": null, "inputFields": [ { "name": "name", "description": "The name of the new wish list", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "visibility", "description": "Indicates whether the wish list is public or private", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "WishlistVisibilityEnum", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CreateWishlistOutput", "description": "", "fields": [ { "name": "wishlist", "description": "The newly-created wish list", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Wishlist", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DeleteCompareListOutput", "description": "", "fields": [ { "name": "result", "description": "Indicates whether the compare list was successfully deleted", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DeletePaymentTokenOutput", "description": "", "fields": [ { "name": "customerPaymentTokens", "description": null, "args": [], "type": { "kind": "OBJECT", "name": "CustomerPaymentTokens", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "result", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DeleteWishlistOutput", "description": "", "fields": [ { "name": "status", "description": "Indicates whether the wish list was deleted", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "wishlists", "description": "A list of undeleted wish lists", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "Wishlist", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomerToken", "description": "", "fields": [ { "name": "token", "description": "The customer token", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "GenerateCustomerTokenAsAdminInput", "description": "", "fields": null, "inputFields": [ { "name": "customer_email", "description": "The email address of the customer requesting remote shopping assistance", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "GenerateCustomerTokenAsAdminOutput", "description": "", "fields": [ { "name": "customer_token", "description": "The generated customer token", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "PayflowProResponseInput", "description": "Input required to complete payment. Applies to Payflow Pro and Payments Pro payment methods.", "fields": null, "inputFields": [ { "name": "cart_id", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "paypal_payload", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PayflowProResponseOutput", "description": "", "fields": [ { "name": "cart", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Cart", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "WishlistItemMoveInput", "description": "", "fields": null, "inputFields": [ { "name": "quantity", "description": "The quantity of this item to move to the destination wish list. This value can't be greater than the quantity in the source wish list.", "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "defaultValue": null }, { "name": "wishlist_item_id", "description": "filtered by the unique ID for a `WishlistItemInterface` object to be moved", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "MoveProductsBetweenWishlistsOutput", "description": "", "fields": [ { "name": "destination_wishlist", "description": "The destination wish list after receiving products move from the source wish list", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Wishlist", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "source_wishlist", "description": "The source wish list after moving products from it", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Wishlist", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "user_errors", "description": "An array of errors encountered while moving products in a wish list", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "WishListUserInputError", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "PlaceOrderInput", "description": "", "fields": null, "inputFields": [ { "name": "cart_id", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PlaceOrderOutput", "description": "", "fields": [ { "name": "order", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Order", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "Order", "description": "", "fields": [ { "name": "order_id", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "The order_id field is deprecated, use order_number instead." }, { "name": "order_number", "description": "The unique ID for a `Order` object.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "RemoveCouponFromCartInput", "description": "", "fields": null, "inputFields": [ { "name": "cart_id", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "RemoveCouponFromCartOutput", "description": "", "fields": [ { "name": "cart", "description": null, "args": [], "type": { "kind": "OBJECT", "name": "Cart", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "RemoveGiftCardFromCartInput", "description": "Defines the input required to run the removeGiftCardFromCart mutation", "fields": null, "inputFields": [ { "name": "cart_id", "description": "The unique ID that identifies the customer's cart", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "gift_card_code", "description": "The gift card code to be removed to the cart", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "RemoveGiftCardFromCartOutput", "description": "Defines the possible output for the removeGiftCardFromCart mutation", "fields": [ { "name": "cart", "description": "Describes the contents of the specified shopping cart", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Cart", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "RemoveItemFromCartInput", "description": "", "fields": null, "inputFields": [ { "name": "cart_id", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "cart_item_id", "description": "Deprecated. Use `cart_item_uid` instead.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "cart_item_uid", "description": "Required field. The unique ID for a `CartItemInterface` object", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "RemoveItemFromCartOutput", "description": "", "fields": [ { "name": "cart", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Cart", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "RemoveProductsFromCompareListInput", "description": "", "fields": null, "inputFields": [ { "name": "products", "description": "An array of product IDs to remove from the compare list", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null }, { "name": "uid", "description": "The unique identifier of the compare list to modify", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "RemoveProductsFromWishlistOutput", "description": "Contains the customer's wish list and any errors encountered", "fields": [ { "name": "user_errors", "description": "An array of errors encountered while deleting products from a wish list", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "WishListUserInputError", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "wishlist", "description": "Contains the wish list with after items were successfully deleted", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Wishlist", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "RemoveReturnTrackingInput", "description": "", "fields": null, "inputFields": [ { "name": "return_shipping_tracking_uid", "description": "The unique ID for a `ReturnShippingTracking` object", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "RemoveReturnTrackingOutput", "description": "", "fields": [ { "name": "return", "description": "Contains details about the modified return", "args": [], "type": { "kind": "OBJECT", "name": "Return", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "RemoveRewardPointsFromCartOutput", "description": "", "fields": [ { "name": "cart", "description": "The customer cart after reward points are removed", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Cart", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "RemoveStoreCreditFromCartInput", "description": "Defines the input required to run the removeStoreCreditFromCart mutation", "fields": null, "inputFields": [ { "name": "cart_id", "description": "The unique ID that identifies the customer's cart", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "RemoveStoreCreditFromCartOutput", "description": "Defines the possible output for the removeStoreCreditFromCart mutation", "fields": [ { "name": "cart", "description": "Describes the contents of the specified shopping cart", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Cart", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ReorderItemsOutput", "description": "", "fields": [ { "name": "cart", "description": "Contains detailed information about the customer's cart.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Cart", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "userInputErrors", "description": "An array of reordering errors.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "CheckoutUserInputError", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CheckoutUserInputError", "description": "An error encountered while adding an item the the cart.", "fields": [ { "name": "code", "description": "Checkout-specific error code", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "CheckoutUserInputErrorCodes", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "Localized error message", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "path", "description": "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", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "CheckoutUserInputErrorCodes", "description": "", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "REORDER_NOT_AVAILABLE", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "PRODUCT_NOT_FOUND", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "NOT_SALABLE", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "INSUFFICIENT_STOCK", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "UNDEFINED", "description": "", "isDeprecated": false, "deprecationReason": "" } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "RequestReturnInput", "description": "", "fields": null, "inputFields": [ { "name": "comment_text", "description": "Text the buyer entered that describes the reason for the refund request", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "contact_email", "description": "An email address the buyer enters to receive notifications about the status of the return", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "items", "description": "An array of items to be returned", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "RequestReturnItemInput", "ofType": null } } }, "defaultValue": null }, { "name": "order_uid", "description": "The unique ID for a `Order` object", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "RequestReturnItemInput", "description": "", "fields": null, "inputFields": [ { "name": "entered_custom_attributes", "description": "Contains details about a custom attribute that was entered, such as text or a file", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "EnteredCustomAttributeInput", "ofType": null } }, "defaultValue": null }, { "name": "order_item_uid", "description": "The unique ID for a `OrderItemInterface` object", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "quantity_to_return", "description": "The quantity of the item to be returned", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "defaultValue": null }, { "name": "selected_custom_attributes", "description": "An array of selected custom option IDs associated with the item to be returned. For example, the IDs for the selected color and size of a configurable product", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "SelectedCustomAttributeInput", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "EnteredCustomAttributeInput", "description": "", "fields": null, "inputFields": [ { "name": "attribute_code", "description": "A string that identifies the entered custom attribute", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "value", "description": "The text or other entered value", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SelectedCustomAttributeInput", "description": "", "fields": null, "inputFields": [ { "name": "attribute_code", "description": "A string that identifies the selected attribute", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "value", "description": "The unique ID for a `CustomAttribute` object of a selected custom attribute", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "RequestReturnOutput", "description": "", "fields": [ { "name": "return", "description": "Contains details about a single return request", "args": [], "type": { "kind": "OBJECT", "name": "Return", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "returns", "description": "Contains an array of return requests", "args": [ { "name": "pageSize", "description": "Specifies the maximum number of results to return at once. The default is 20", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": "20" }, { "name": "currentPage", "description": "Specifies which page of results to return. The default value is 1", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": "1" } ], "type": { "kind": "OBJECT", "name": "Returns", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "RevokeCustomerTokenOutput", "description": "", "fields": [ { "name": "result", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SendEmailToFriendInput", "description": "", "fields": null, "inputFields": [ { "name": "product_id", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "defaultValue": null }, { "name": "recipients", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "SendEmailToFriendRecipientInput", "ofType": null } } }, "defaultValue": null }, { "name": "sender", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "SendEmailToFriendSenderInput", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SendEmailToFriendRecipientInput", "description": "", "fields": null, "inputFields": [ { "name": "email", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "name", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SendEmailToFriendSenderInput", "description": "", "fields": null, "inputFields": [ { "name": "email", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "message", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "name", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SendEmailToFriendOutput", "description": "", "fields": [ { "name": "recipients", "description": null, "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "SendEmailToFriendRecipient", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "sender", "description": null, "args": [], "type": { "kind": "OBJECT", "name": "SendEmailToFriendSender", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SendEmailToFriendRecipient", "description": "", "fields": [ { "name": "email", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SendEmailToFriendSender", "description": "", "fields": [ { "name": "email", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SetBillingAddressOnCartInput", "description": "", "fields": null, "inputFields": [ { "name": "billing_address", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "BillingAddressInput", "ofType": null } }, "defaultValue": null }, { "name": "cart_id", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "BillingAddressInput", "description": "", "fields": null, "inputFields": [ { "name": "address", "description": "", "type": { "kind": "INPUT_OBJECT", "name": "CartAddressInput", "ofType": null }, "defaultValue": null }, { "name": "customer_address_id", "description": "", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "same_as_shipping", "description": "Set billing address same as shipping", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "use_for_shipping", "description": "Deprecated: use `same_as_shipping` field instead", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CartAddressInput", "description": "", "fields": null, "inputFields": [ { "name": "city", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "company", "description": "", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "country_code", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "firstname", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "lastname", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "postcode", "description": "", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "region", "description": "", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "region_id", "description": "", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "save_in_address_book", "description": "Determines whether to save the address in the customer's address book. The default value is true", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "street", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } } }, "defaultValue": null }, { "name": "telephone", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SetBillingAddressOnCartOutput", "description": "", "fields": [ { "name": "cart", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Cart", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SetGiftOptionsOnCartInput", "description": "", "fields": null, "inputFields": [ { "name": "cart_id", "description": "The unique ID that identifies the shopper's cart", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "gift_message", "description": "Gift message details for the cart", "type": { "kind": "INPUT_OBJECT", "name": "GiftMessageInput", "ofType": null }, "defaultValue": null }, { "name": "gift_receipt_included", "description": "Whether customer requested gift receipt for the cart", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "defaultValue": null }, { "name": "gift_wrapping_id", "description": "The unique ID for a `GiftWrapping` object to be used for the cart", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "printed_card_included", "description": "Whether customer requested printed card for the cart", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "GiftMessageInput", "description": "Contains the text of a gift message, its sender, and recipient", "fields": null, "inputFields": [ { "name": "from", "description": "Sender name", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "message", "description": "Gift message text", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "to", "description": "Recepient name", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SetGiftOptionsOnCartOutput", "description": "", "fields": [ { "name": "cart", "description": "The modified cart object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Cart", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SetGuestEmailOnCartInput", "description": "", "fields": null, "inputFields": [ { "name": "cart_id", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "email", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SetGuestEmailOnCartOutput", "description": "", "fields": [ { "name": "cart", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Cart", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SetPaymentMethodAndPlaceOrderInput", "description": "", "fields": null, "inputFields": [ { "name": "cart_id", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "payment_method", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "PaymentMethodInput", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "PaymentMethodInput", "description": "", "fields": null, "inputFields": [ { "name": "braintree", "description": "", "type": { "kind": "INPUT_OBJECT", "name": "BraintreeInput", "ofType": null }, "defaultValue": null }, { "name": "braintree_cc_vault", "description": "", "type": { "kind": "INPUT_OBJECT", "name": "BraintreeCcVaultInput", "ofType": null }, "defaultValue": null }, { "name": "code", "description": "Payment method code", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "hosted_pro", "description": "Required input for PayPal Hosted pro payments", "type": { "kind": "INPUT_OBJECT", "name": "HostedProInput", "ofType": null }, "defaultValue": null }, { "name": "klarna", "description": "", "type": { "kind": "INPUT_OBJECT", "name": "KlarnaInput", "ofType": null }, "defaultValue": null }, { "name": "payflow_express", "description": "Required input for Payflow Express Checkout payments", "type": { "kind": "INPUT_OBJECT", "name": "PayflowExpressInput", "ofType": null }, "defaultValue": null }, { "name": "payflow_link", "description": "Required input for PayPal Payflow Link and Payments Advanced payments", "type": { "kind": "INPUT_OBJECT", "name": "PayflowLinkInput", "ofType": null }, "defaultValue": null }, { "name": "payflowpro", "description": "Required input type for PayPal Payflow Pro and Payment Pro payments", "type": { "kind": "INPUT_OBJECT", "name": "PayflowProInput", "ofType": null }, "defaultValue": null }, { "name": "payflowpro_cc_vault", "description": "Required input type for PayPal Payflow Pro vault payments", "type": { "kind": "INPUT_OBJECT", "name": "VaultTokenInput", "ofType": null }, "defaultValue": null }, { "name": "paypal_express", "description": "Required input for Express Checkout and Payments Standard payments", "type": { "kind": "INPUT_OBJECT", "name": "PaypalExpressInput", "ofType": null }, "defaultValue": null }, { "name": "purchase_order_number", "description": "Purchase order number", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "BraintreeInput", "description": "", "fields": null, "inputFields": [ { "name": "device_data", "description": "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.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "is_active_payment_token_enabler", "description": "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.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "defaultValue": null }, { "name": "payment_method_nonce", "description": "The one-time payment token generated by Braintree payment gateway based on card details. Required field to make sale transaction.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "BraintreeCcVaultInput", "description": "", "fields": null, "inputFields": [ { "name": "device_data", "description": "", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "public_hash", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "HostedProInput", "description": "A set of relative URLs that PayPal will use in response to various actions during the authorization process. Magento prepends the base URL to this value to create a full URL. For example, if the full URL is https://www.example.com/path/to/page.html, the relative URL is path/to/page.html. Use this input for Payments Pro Hosted Solution payment method.", "fields": null, "inputFields": [ { "name": "cancel_url", "description": "The relative URL of the page that PayPal will redirect to when the buyer cancels the transaction in order to choose a different payment method. If the full URL to this page is https://www.example.com/paypal/action/cancel.html, the relative URL is paypal/action/cancel.html.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "return_url", "description": "The relative URL of the final confirmation page that PayPal will redirect to upon payment success. If the full URL to this page is https://www.example.com/paypal/action/return.html, the relative URL is paypal/action/return.html.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "KlarnaInput", "description": "", "fields": null, "inputFields": [ { "name": "authorization_token", "description": "The authorization token must be provided to set any Klarna Payments method", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "PayflowExpressInput", "description": "Required input for Payflow Express Checkout payments", "fields": null, "inputFields": [ { "name": "payer_id", "description": "The unique ID of the PayPal user", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "token", "description": "The token returned by the createPaypalExpressToken mutation", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "PayflowLinkInput", "description": "A set of relative URLs that PayPal will use in response to various actions during the authorization process. Magento prepends the base URL to this value to create a full URL. For example, if the full URL is https://www.example.com/path/to/page.html, the relative URL is path/to/page.html. Use this input for Payflow Link and Payments Advanced payment methods.", "fields": null, "inputFields": [ { "name": "cancel_url", "description": "The relative URL of the page that PayPal will redirect to when the buyer cancels the transaction in order to choose a different payment method. If the full URL to this page is https://www.example.com/paypal/action/cancel.html, the relative URL is paypal/action/cancel.html.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "error_url", "description": "The relative URL of the transaction error page that PayPal will redirect to upon payment error. If the full URL to this page is https://www.example.com/paypal/action/error.html, the relative URL is paypal/action/error.html.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "return_url", "description": "The relative URL of the order confirmation page that PayPal will redirect to when the payment is successful and additional confirmation is not needed. If the full URL to this page is https://www.example.com/paypal/action/return.html, the relative URL is paypal/action/return.html.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "PayflowProInput", "description": "Required input for Payflow Pro and Payments Pro payment methods.", "fields": null, "inputFields": [ { "name": "cc_details", "description": "Required input for credit card related information", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CreditCardDetailsInput", "ofType": null } }, "defaultValue": null }, { "name": "is_active_payment_token_enabler", "description": "States whether details about the customer's credit/debit card should be tokenized for later usage. Required only if Vault is enabled for PayPal Payflow Pro payment integration.", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CreditCardDetailsInput", "description": "Required fields for Payflow Pro and Payments Pro credit card payments", "fields": null, "inputFields": [ { "name": "cc_exp_month", "description": "Credit card expiration month", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "defaultValue": null }, { "name": "cc_exp_year", "description": "Credit card expiration year", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "defaultValue": null }, { "name": "cc_last_4", "description": "Last 4 digits of the credit card", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "defaultValue": null }, { "name": "cc_type", "description": "Credit card type", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "VaultTokenInput", "description": "Required input for payment methods with Vault support.", "fields": null, "inputFields": [ { "name": "public_hash", "description": "The public hash of the payment token", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "PaypalExpressInput", "description": "Required input for Express Checkout and Payments Standard payments", "fields": null, "inputFields": [ { "name": "payer_id", "description": "The unique ID of the PayPal user", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "token", "description": "The token returned by the createPaypalExpressToken mutation", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SetPaymentMethodOnCartInput", "description": "", "fields": null, "inputFields": [ { "name": "cart_id", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "payment_method", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "PaymentMethodInput", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SetPaymentMethodOnCartOutput", "description": "", "fields": [ { "name": "cart", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Cart", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SetShippingAddressesOnCartInput", "description": "", "fields": null, "inputFields": [ { "name": "cart_id", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "shipping_addresses", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "ShippingAddressInput", "ofType": null } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ShippingAddressInput", "description": "", "fields": null, "inputFields": [ { "name": "address", "description": "", "type": { "kind": "INPUT_OBJECT", "name": "CartAddressInput", "ofType": null }, "defaultValue": null }, { "name": "customer_address_id", "description": "", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "customer_notes", "description": "", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "pickup_location_code", "description": "The code of Pickup Location which will be used for In-Store Pickup.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SetShippingAddressesOnCartOutput", "description": "", "fields": [ { "name": "cart", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Cart", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "SetShippingMethodsOnCartInput", "description": "", "fields": null, "inputFields": [ { "name": "cart_id", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "shipping_methods", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "ShippingMethodInput", "ofType": null } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ShippingMethodInput", "description": "", "fields": null, "inputFields": [ { "name": "carrier_code", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "method_code", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SetShippingMethodsOnCartOutput", "description": "", "fields": [ { "name": "cart", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Cart", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SubscribeEmailToNewsletterOutput", "description": "", "fields": [ { "name": "status", "description": "Returns the status of the subscription request", "args": [], "type": { "kind": "ENUM", "name": "SubscriptionStatusesEnum", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "SubscriptionStatusesEnum", "description": "", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "NOT_ACTIVE", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "SUBSCRIBED", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "UNSUBSCRIBED", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "UNCONFIRMED", "description": "", "isDeprecated": false, "deprecationReason": "" } ], "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "UpdateCartItemsInput", "description": "", "fields": null, "inputFields": [ { "name": "cart_id", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "defaultValue": null }, { "name": "cart_items", "description": "", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CartItemUpdateInput", "ofType": null } } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CartItemUpdateInput", "description": "", "fields": null, "inputFields": [ { "name": "cart_item_id", "description": "Deprecated. Use `cart_item_uid` instead.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "cart_item_uid", "description": "The unique ID for a `CartItemInterface` object", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "customizable_options", "description": "", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "CustomizableOptionInput", "ofType": null } }, "defaultValue": null }, { "name": "gift_message", "description": "Gift message details for the cart item", "type": { "kind": "INPUT_OBJECT", "name": "GiftMessageInput", "ofType": null }, "defaultValue": null }, { "name": "gift_wrapping_id", "description": "The unique ID for a `GiftWrapping` object to be used for the cart item", "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "defaultValue": null }, { "name": "quantity", "description": "", "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "UpdateCartItemsOutput", "description": "", "fields": [ { "name": "cart", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Cart", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "CustomerUpdateInput", "description": "", "fields": null, "inputFields": [ { "name": "allow_remote_shopping_assistance", "description": "Indicates whether the customer has enabled remote shopping assistance", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "date_of_birth", "description": "The customer's date of birth", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "dob", "description": "Deprecated: Use `date_of_birth` instead", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "firstname", "description": "The customer's first name", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "gender", "description": "The customer's gender (Male - 1, Female - 2)", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": null }, { "name": "is_subscribed", "description": "Indicates whether the customer is subscribed to the company's newsletter", "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": null }, { "name": "lastname", "description": "The customer's family name", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "middlename", "description": "The customer's middle name", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "prefix", "description": "An honorific, such as Dr., Mr., or Mrs.", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "suffix", "description": "A value such as Sr., Jr., or III", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "taxvat", "description": "The customer's Tax/VAT number (for corporate customers)", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "WishlistItemUpdateInput", "description": "Defines updates to items in a wish list", "fields": null, "inputFields": [ { "name": "description", "description": "Customer-entered comments about the item", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": null }, { "name": "entered_options", "description": "An array of options that the customer entered", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INPUT_OBJECT", "name": "EnteredOptionInput", "ofType": null } }, "defaultValue": null }, { "name": "quantity", "description": "The new amount or number of this item", "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "defaultValue": null }, { "name": "selected_options", "description": "An array of strings corresponding to options the customer selected", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null }, { "name": "wishlist_item_id", "description": "The unique ID for a `WishlistItemInterface` object", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "UpdateProductsInWishlistOutput", "description": "Contains the customer's wish list and any errors encountered", "fields": [ { "name": "user_errors", "description": "An array of errors encountered while updating products in a wish list", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "WishListUserInputError", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "wishlist", "description": "Contains the wish list with all items that were successfully updated", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Wishlist", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "UpdateWishlistOutput", "description": "", "fields": [ { "name": "name", "description": "The wish list name", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "uid", "description": "The unique ID for a `Wishlist` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "visibility", "description": "Indicates whether the wish list is public or private", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "WishlistVisibilityEnum", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "__Schema", "description": "A GraphQL Schema defines the capabilities of a GraphQL server. It exposes all available types and directives on the server, as well as the entry points for query, mutation, and subscription operations.", "fields": [ { "name": "types", "description": "A list of all types supported by this server.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "__Type", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "queryType", "description": "The type that query operations will be rooted at.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "__Type", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "mutationType", "description": "If this server supports mutation, the type that mutation operations will be rooted at.", "args": [], "type": { "kind": "OBJECT", "name": "__Type", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "subscriptionType", "description": "If this server support subscription, the type that subscription operations will be rooted at.", "args": [], "type": { "kind": "OBJECT", "name": "__Type", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "directives", "description": "A list of all directives supported by this server.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "__Directive", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "__Type", "description": "The fundamental unit of any GraphQL Schema is the type. There are many kinds of types in GraphQL as represented by the `__TypeKind` enum.\n\nDepending on the kind of a type, certain fields describe information about that type. Scalar types provide no information beyond a name and description, while Enum types provide their values. Object and Interface types provide the fields they describe. Abstract types, Union and Interface, provide the Object types possible at runtime. List and NonNull types compose other types.", "fields": [ { "name": "kind", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "__TypeKind", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fields", "description": null, "args": [ { "name": "includeDeprecated", "description": null, "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "__Field", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "interfaces", "description": null, "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "__Type", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "possibleTypes", "description": null, "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "__Type", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "enumValues", "description": null, "args": [ { "name": "includeDeprecated", "description": null, "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "defaultValue": "false" } ], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "__EnumValue", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "inputFields", "description": null, "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "__InputValue", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "ofType", "description": null, "args": [], "type": { "kind": "OBJECT", "name": "__Type", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "__TypeKind", "description": "An enum describing what kind of type a given `__Type` is.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "SCALAR", "description": "Indicates this type is a scalar.", "isDeprecated": false, "deprecationReason": null }, { "name": "OBJECT", "description": "Indicates this type is an object. `fields` and `interfaces` are valid fields.", "isDeprecated": false, "deprecationReason": null }, { "name": "INTERFACE", "description": "Indicates this type is an interface. `fields` and `possibleTypes` are valid fields.", "isDeprecated": false, "deprecationReason": null }, { "name": "UNION", "description": "Indicates this type is a union. `possibleTypes` is a valid field.", "isDeprecated": false, "deprecationReason": null }, { "name": "ENUM", "description": "Indicates this type is an enum. `enumValues` is a valid field.", "isDeprecated": false, "deprecationReason": null }, { "name": "INPUT_OBJECT", "description": "Indicates this type is an input object. `inputFields` is a valid field.", "isDeprecated": false, "deprecationReason": null }, { "name": "LIST", "description": "Indicates this type is a list. `ofType` is a valid field.", "isDeprecated": false, "deprecationReason": null }, { "name": "NON_NULL", "description": "Indicates this type is a non-null. `ofType` is a valid field.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "__Field", "description": "Object and Interface types are described by a list of Fields, each of which has a name, potentially a list of arguments, and a return type.", "fields": [ { "name": "name", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "args", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "__InputValue", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "type", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "__Type", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "isDeprecated", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "deprecationReason", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "__InputValue", "description": "Arguments provided to Fields or Directives and the input fields of an InputObject are represented as Input Values which describe their type and optionally a default value.", "fields": [ { "name": "name", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "type", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "__Type", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "defaultValue", "description": "A GraphQL-formatted string representing the default value for this input value.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "__EnumValue", "description": "One possible value for a given Enum. Enum values are unique values, not a placeholder for a string or numeric value. However an Enum value is returned in a JSON response as a string.", "fields": [ { "name": "name", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "isDeprecated", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "deprecationReason", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "__Directive", "description": "A Directive provides a way to describe alternate runtime execution and type validation behavior in a GraphQL document.\n\nIn some cases, you need to provide options to alter GraphQL's execution behavior in ways field arguments will not suffice, such as conditionally including or skipping a field. Directives provide this by describing additional information to the executor.", "fields": [ { "name": "name", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "locations", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "ENUM", "name": "__DirectiveLocation", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "args", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "__InputValue", "ofType": null } } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "__DirectiveLocation", "description": "A Directive can be adjacent to many parts of the GraphQL language, a __DirectiveLocation describes one such possible adjacencies.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "QUERY", "description": "Location adjacent to a query operation.", "isDeprecated": false, "deprecationReason": null }, { "name": "MUTATION", "description": "Location adjacent to a mutation operation.", "isDeprecated": false, "deprecationReason": null }, { "name": "SUBSCRIPTION", "description": "Location adjacent to a subscription operation.", "isDeprecated": false, "deprecationReason": null }, { "name": "FIELD", "description": "Location adjacent to a field.", "isDeprecated": false, "deprecationReason": null }, { "name": "FRAGMENT_DEFINITION", "description": "Location adjacent to a fragment definition.", "isDeprecated": false, "deprecationReason": null }, { "name": "FRAGMENT_SPREAD", "description": "Location adjacent to a fragment spread.", "isDeprecated": false, "deprecationReason": null }, { "name": "INLINE_FRAGMENT", "description": "Location adjacent to an inline fragment.", "isDeprecated": false, "deprecationReason": null }, { "name": "VARIABLE_DEFINITION", "description": "Location adjacent to a variable definition.", "isDeprecated": false, "deprecationReason": null }, { "name": "SCHEMA", "description": "Location adjacent to a schema definition.", "isDeprecated": false, "deprecationReason": null }, { "name": "SCALAR", "description": "Location adjacent to a scalar definition.", "isDeprecated": false, "deprecationReason": null }, { "name": "OBJECT", "description": "Location adjacent to an object type definition.", "isDeprecated": false, "deprecationReason": null }, { "name": "FIELD_DEFINITION", "description": "Location adjacent to a field definition.", "isDeprecated": false, "deprecationReason": null }, { "name": "ARGUMENT_DEFINITION", "description": "Location adjacent to an argument definition.", "isDeprecated": false, "deprecationReason": null }, { "name": "INTERFACE", "description": "Location adjacent to an interface definition.", "isDeprecated": false, "deprecationReason": null }, { "name": "UNION", "description": "Location adjacent to a union definition.", "isDeprecated": false, "deprecationReason": null }, { "name": "ENUM", "description": "Location adjacent to an enum definition.", "isDeprecated": false, "deprecationReason": null }, { "name": "ENUM_VALUE", "description": "Location adjacent to an enum value definition.", "isDeprecated": false, "deprecationReason": null }, { "name": "INPUT_OBJECT", "description": "Location adjacent to an input object type definition.", "isDeprecated": false, "deprecationReason": null }, { "name": "INPUT_FIELD_DEFINITION", "description": "Location adjacent to an input object field definition.", "isDeprecated": false, "deprecationReason": null } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductLinks", "description": "ProductLinks is an implementation of ProductLinksInterface.", "fields": [ { "name": "link_type", "description": "One of related, associated, upsell, or crosssell.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "linked_product_sku", "description": "The SKU of the linked product.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "linked_product_type", "description": "The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable).", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "position", "description": "The position within the list of product links.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sku", "description": "The identifier of the linked product.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "ProductLinksInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "INTERFACE", "name": "PhysicalProductInterface", "description": "PhysicalProductInterface contains attributes specific to tangible products.", "fields": [ { "name": "weight", "description": "The weight of the item, in units defined by the store.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "SimpleProduct", "ofType": null }, { "kind": "OBJECT", "name": "BundleProduct", "ofType": null }, { "kind": "OBJECT", "name": "GroupedProduct", "ofType": null }, { "kind": "OBJECT", "name": "ConfigurableProduct", "ofType": null }, { "kind": "OBJECT", "name": "GiftCardProduct", "ofType": null } ] }, { "kind": "OBJECT", "name": "CustomizableAreaOption", "description": "CustomizableAreaOption contains information about a text area that is defined as part of a customizable option.", "fields": [ { "name": "option_id", "description": "Option ID.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `uid` instead" }, { "name": "product_sku", "description": "The Stock Keeping Unit of the base product.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "required", "description": "Indicates whether the option is required.", "args": [], "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sort_order", "description": "The order in which the option is displayed.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The display name for this option.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "uid", "description": "The unique ID for a `CustomizableOptionInterface` object.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "An object that defines a text area.", "args": [], "type": { "kind": "OBJECT", "name": "CustomizableAreaValue", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "CustomizableOptionInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "INTERFACE", "name": "CustomizableOptionInterface", "description": "The CustomizableOptionInterface contains basic information about a customizable option. It can be implemented by several types of configurable options.", "fields": [ { "name": "option_id", "description": "Option ID.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `uid` instead" }, { "name": "required", "description": "Indicates whether the option is required.", "args": [], "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sort_order", "description": "The order in which the option is displayed.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The display name for this option.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "uid", "description": "The unique ID for a `CustomizableOptionInterface` object.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "CustomizableAreaOption", "ofType": null }, { "kind": "OBJECT", "name": "CustomizableDateOption", "ofType": null }, { "kind": "OBJECT", "name": "CustomizableDropDownOption", "ofType": null }, { "kind": "OBJECT", "name": "CustomizableMultipleOption", "ofType": null }, { "kind": "OBJECT", "name": "CustomizableFieldOption", "ofType": null }, { "kind": "OBJECT", "name": "CustomizableFileOption", "ofType": null }, { "kind": "OBJECT", "name": "CustomizableRadioOption", "ofType": null }, { "kind": "OBJECT", "name": "CustomizableCheckboxOption", "ofType": null } ] }, { "kind": "OBJECT", "name": "CustomizableAreaValue", "description": "CustomizableAreaValue defines the price and sku of a product whose page contains a customized text area.", "fields": [ { "name": "max_characters", "description": "The maximum number of characters that can be entered for this customizable option.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "price", "description": "The price assigned to this option.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "price_type", "description": "FIXED, PERCENT, or DYNAMIC.", "args": [], "type": { "kind": "ENUM", "name": "PriceTypeEnum", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sku", "description": "The Stock Keeping Unit for this option.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "uid", "description": "The unique ID for a `CustomizableAreaValue` object.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomizableDateOption", "description": "CustomizableDateOption contains information about a date picker that is defined as part of a customizable option.", "fields": [ { "name": "option_id", "description": "Option ID.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `uid` instead" }, { "name": "product_sku", "description": "The Stock Keeping Unit of the base product.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "required", "description": "Indicates whether the option is required.", "args": [], "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sort_order", "description": "The order in which the option is displayed.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The display name for this option.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "uid", "description": "The unique ID for a `CustomizableOptionInterface` object.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "An object that defines a date field in a customizable option.", "args": [], "type": { "kind": "OBJECT", "name": "CustomizableDateValue", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "CustomizableOptionInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomizableDateValue", "description": "CustomizableDateValue defines the price and sku of a product whose page contains a customized date picker.", "fields": [ { "name": "price", "description": "The price assigned to this option.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "price_type", "description": "FIXED, PERCENT, or DYNAMIC.", "args": [], "type": { "kind": "ENUM", "name": "PriceTypeEnum", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sku", "description": "The Stock Keeping Unit for this option.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "uid", "description": "The unique ID for a `CustomizableDateValue` object.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomizableDropDownOption", "description": "CustomizableDropDownOption contains information about a drop down menu that is defined as part of a customizable option.", "fields": [ { "name": "option_id", "description": "Option ID.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `uid` instead" }, { "name": "required", "description": "Indicates whether the option is required.", "args": [], "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sort_order", "description": "The order in which the option is displayed.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The display name for this option.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "uid", "description": "The unique ID for a `CustomizableOptionInterface` object.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "An array that defines the set of options for a drop down menu.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "CustomizableDropDownValue", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "CustomizableOptionInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomizableDropDownValue", "description": "CustomizableDropDownValue defines the price and sku of a product whose page contains a customized drop down menu.", "fields": [ { "name": "option_type_id", "description": "The ID assigned to the value.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "price", "description": "The price assigned to this option.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "price_type", "description": "FIXED, PERCENT, or DYNAMIC.", "args": [], "type": { "kind": "ENUM", "name": "PriceTypeEnum", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sku", "description": "The Stock Keeping Unit for this option.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sort_order", "description": "The order in which the option is displayed.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The display name for this option.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "uid", "description": "The unique ID for a `CustomizableDropDownValue` object.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomizableMultipleOption", "description": "CustomizableMultipleOption contains information about a multiselect that is defined as part of a customizable option.", "fields": [ { "name": "option_id", "description": "Option ID.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `uid` instead" }, { "name": "required", "description": "Indicates whether the option is required.", "args": [], "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sort_order", "description": "The order in which the option is displayed.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The display name for this option.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "uid", "description": "The unique ID for a `CustomizableOptionInterface` object.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "An array that defines the set of options for a multiselect.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "CustomizableMultipleValue", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "CustomizableOptionInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomizableMultipleValue", "description": "CustomizableMultipleValue defines the price and sku of a product whose page contains a customized multiselect.", "fields": [ { "name": "option_type_id", "description": "The ID assigned to the value.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "price", "description": "The price assigned to this option.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "price_type", "description": "FIXED, PERCENT, or DYNAMIC.", "args": [], "type": { "kind": "ENUM", "name": "PriceTypeEnum", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sku", "description": "The Stock Keeping Unit for this option.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sort_order", "description": "The order in which the option is displayed.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The display name for this option.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "uid", "description": "The unique ID for a `CustomizableMultipleValue` object.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomizableFieldOption", "description": "CustomizableFieldOption contains information about a text field that is defined as part of a customizable option.", "fields": [ { "name": "option_id", "description": "Option ID.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `uid` instead" }, { "name": "product_sku", "description": "The Stock Keeping Unit of the base product.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "required", "description": "Indicates whether the option is required.", "args": [], "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sort_order", "description": "The order in which the option is displayed.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The display name for this option.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "uid", "description": "The unique ID for a `CustomizableOptionInterface` object.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "An object that defines a text field.", "args": [], "type": { "kind": "OBJECT", "name": "CustomizableFieldValue", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "CustomizableOptionInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomizableFieldValue", "description": "CustomizableFieldValue defines the price and sku of a product whose page contains a customized text field.", "fields": [ { "name": "max_characters", "description": "The maximum number of characters that can be entered for this customizable option.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "price", "description": "The price of the custom value.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "price_type", "description": "FIXED, PERCENT, or DYNAMIC.", "args": [], "type": { "kind": "ENUM", "name": "PriceTypeEnum", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sku", "description": "The Stock Keeping Unit for this option.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "uid", "description": "The unique ID for a `CustomizableFieldValue` object.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomizableFileOption", "description": "CustomizableFileOption contains information about a file picker that is defined as part of a customizable option.", "fields": [ { "name": "option_id", "description": "Option ID.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `uid` instead" }, { "name": "product_sku", "description": "The Stock Keeping Unit of the base product.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "required", "description": "Indicates whether the option is required.", "args": [], "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sort_order", "description": "The order in which the option is displayed.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The display name for this option.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "uid", "description": "The unique ID for a `CustomizableOptionInterface` object.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "An object that defines a file value.", "args": [], "type": { "kind": "OBJECT", "name": "CustomizableFileValue", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "CustomizableOptionInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomizableFileValue", "description": "CustomizableFileValue defines the price and sku of a product whose page contains a customized file picker.", "fields": [ { "name": "file_extension", "description": "The file extension to accept.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "image_size_x", "description": "The maximum width of an image.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "image_size_y", "description": "The maximum height of an image.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "price", "description": "The price assigned to this option.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "price_type", "description": "FIXED, PERCENT, or DYNAMIC.", "args": [], "type": { "kind": "ENUM", "name": "PriceTypeEnum", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sku", "description": "The Stock Keeping Unit for this option.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "uid", "description": "The unique ID for a `CustomizableFileValue` object.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ProductVideo", "description": "Contains information about a product video.", "fields": [ { "name": "disabled", "description": "Whether the image is hidden from view.", "args": [], "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "label", "description": "The label of the product image or video.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "position", "description": "The media item's position after it has been sorted.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "url", "description": "The URL of the product image or video.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "video_content", "description": "Contains a ProductMediaGalleryEntriesVideoContent object.", "args": [], "type": { "kind": "OBJECT", "name": "ProductMediaGalleryEntriesVideoContent", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "MediaGalleryInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "INTERFACE", "name": "CustomizableProductInterface", "description": "CustomizableProductInterface contains information about customizable product options.", "fields": [ { "name": "options", "description": "An array of options for a customizable product.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "CustomizableOptionInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "VirtualProduct", "ofType": null }, { "kind": "OBJECT", "name": "SimpleProduct", "ofType": null }, { "kind": "OBJECT", "name": "DownloadableProduct", "ofType": null }, { "kind": "OBJECT", "name": "BundleProduct", "ofType": null }, { "kind": "OBJECT", "name": "ConfigurableProduct", "ofType": null }, { "kind": "OBJECT", "name": "GiftCardProduct", "ofType": null } ] }, { "kind": "OBJECT", "name": "CustomizableRadioOption", "description": "CustomizableRadioOption contains information about a set of radio buttons that are defined as part of a customizable option.", "fields": [ { "name": "option_id", "description": "Option ID.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `uid` instead" }, { "name": "required", "description": "Indicates whether the option is required.", "args": [], "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sort_order", "description": "The order in which the option is displayed.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The display name for this option.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "uid", "description": "The unique ID for a `CustomizableOptionInterface` object.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "An array that defines a set of radio buttons.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "CustomizableRadioValue", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "CustomizableOptionInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomizableRadioValue", "description": "CustomizableRadioValue defines the price and sku of a product whose page contains a customized set of radio buttons.", "fields": [ { "name": "option_type_id", "description": "The ID assigned to the value.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "price", "description": "The price assigned to this option.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "price_type", "description": "FIXED, PERCENT, or DYNAMIC.", "args": [], "type": { "kind": "ENUM", "name": "PriceTypeEnum", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sku", "description": "The Stock Keeping Unit for this option.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sort_order", "description": "The order in which the radio button is displayed.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The display name for this option.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "uid", "description": "The unique ID for a `CustomizableRadioValue` object.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomizableCheckboxOption", "description": "CustomizableCheckbbixOption contains information about a set of checkbox values that are defined as part of a customizable option.", "fields": [ { "name": "option_id", "description": "Option ID.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `uid` instead" }, { "name": "required", "description": "Indicates whether the option is required.", "args": [], "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sort_order", "description": "The order in which the option is displayed.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The display name for this option.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "uid", "description": "The unique ID for a `CustomizableOptionInterface` object.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "An array that defines a set of checkbox values.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "CustomizableCheckboxValue", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "CustomizableOptionInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CustomizableCheckboxValue", "description": "CustomizableCheckboxValue defines the price and sku of a product whose page contains a customized set of checkbox values.", "fields": [ { "name": "option_type_id", "description": "The ID assigned to the value.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "price", "description": "The price assigned to this option.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "price_type", "description": "FIXED, PERCENT, or DYNAMIC.", "args": [], "type": { "kind": "ENUM", "name": "PriceTypeEnum", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sku", "description": "The Stock Keeping Unit for this option.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sort_order", "description": "The order in which the checkbox value is displayed.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The display name for this option.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "uid", "description": "The unique ID for a `CustomizableCheckboxValue` object.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "VirtualProduct", "description": "A virtual product is non-tangible product that does not require shipping and is not kept in inventory.", "fields": [ { "name": "attribute_set_id", "description": "The attribute set assigned to the product.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "canonical_url", "description": "Relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "categories", "description": "The categories assigned to a product.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "CategoryInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "color", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "country_of_manufacture", "description": "The product's country of origin.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "created_at", "description": "Timestamp indicating when the product was created.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "crosssell_products", "description": "Crosssell Products", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "ProductInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": "Detailed information about the product. The value can include simple HTML tags.", "args": [], "type": { "kind": "OBJECT", "name": "ComplexTextValue", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fashion_color", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fashion_material", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fashion_size", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fashion_style", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "format", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "gift_message_available", "description": "Indicates whether a gift message is available.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "has_video", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The ID number assigned to the product.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use the `uid` field instead." }, { "name": "image", "description": "The relative path to the main image on the product page.", "args": [], "type": { "kind": "OBJECT", "name": "ProductImage", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "is_returnable", "description": "Indicates whether the product can be returned", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "manufacturer", "description": "A number representing the product's manufacturer.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "media_gallery", "description": "An array of Media Gallery objects.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "MediaGalleryInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "media_gallery_entries", "description": "An array of MediaGalleryEntry objects.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "MediaGalleryEntry", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use product's `media_gallery` instead" }, { "name": "meta_description", "description": "A brief overview of the product for search results listings, maximum 255 characters.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "meta_keyword", "description": "A comma-separated list of keywords that are visible only to search engines.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "meta_title", "description": "A string that is displayed in the title bar and tab of the browser and in search results lists.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The product name. Customers use this name to identify the product.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "new_from_date", "description": "The beginning date for new product listings, and determines if the product is featured as a new product.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "new_to_date", "description": "The end date for new product listings.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "only_x_left_in_stock", "description": "Product stock only x left count", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "options", "description": "An array of options for a customizable product.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "CustomizableOptionInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "options_container", "description": "If the product has multiple options, determines where they appear on the product page.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "price", "description": "A ProductPrices object, indicating the price of an item.", "args": [], "type": { "kind": "OBJECT", "name": "ProductPrices", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use price_range for product price information." }, { "name": "price_range", "description": "A PriceRange object, indicating the range of prices for the product", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PriceRange", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "price_tiers", "description": "An array of TierPrice objects.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "TierPrice", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_links", "description": "An array of ProductLinks objects.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "ProductLinksInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "rating_summary", "description": "The average of all the ratings given to the product.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "related_products", "description": "Related Products", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "ProductInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "review_count", "description": "The total count of all the reviews given to the product.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "reviews", "description": "The list of products reviews.", "args": [ { "name": "pageSize", "description": "Specifies the maximum number of results to return at once.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": "20" }, { "name": "currentPage", "description": "Specifies which page of results to return.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": "1" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductReviews", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "short_description", "description": "A short description of the product. Its use depends on the theme.", "args": [], "type": { "kind": "OBJECT", "name": "ComplexTextValue", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sku", "description": "A number or code assigned to a product to identify the product, options, price, and manufacturer.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "small_image", "description": "The relative path to the small image, which is used on catalog pages.", "args": [], "type": { "kind": "OBJECT", "name": "ProductImage", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "special_from_date", "description": "The beginning date that a product has a special price.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "special_price", "description": "The discounted price of the product.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "special_to_date", "description": "The end date that a product has a special price.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "staged", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "stock_status", "description": "Stock status of the product", "args": [], "type": { "kind": "ENUM", "name": "ProductStockStatus", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "swatch_image", "description": "The file name of a swatch image", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "thumbnail", "description": "The relative path to the product's thumbnail image.", "args": [], "type": { "kind": "OBJECT", "name": "ProductImage", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "tier_price", "description": "The price when tier pricing is in effect and the items purchased threshold has been reached.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use price_tiers for product tier price information." }, { "name": "tier_prices", "description": "An array of ProductTierPrices objects.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductTierPrices", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use price_tiers for product tier price information." }, { "name": "type_id", "description": "One of simple, virtual, bundle, downloadable, grouped, or configurable.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use __typename instead." }, { "name": "uid", "description": "The unique ID for a `ProductInterface` object.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "updated_at", "description": "Timestamp indicating when the product was updated.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "upsell_products", "description": "Upsell Products", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "ProductInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "url_key", "description": "The part of the URL that identifies the product", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "url_path", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use product's `canonical_url` or url rewrites instead" }, { "name": "url_rewrites", "description": "URL rewrites list", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "UrlRewrite", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "url_suffix", "description": "The part of the product URL that is appended after the url key", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "video_file", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "websites", "description": "An array of websites in which the product is available.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "Website", "ofType": null } }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "ProductInterface", "ofType": null }, { "kind": "INTERFACE", "name": "CustomizableProductInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SimpleProduct", "description": "A simple product is tangible and are usually sold as single units or in fixed quantities.", "fields": [ { "name": "attribute_set_id", "description": "The attribute set assigned to the product.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "canonical_url", "description": "Relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "categories", "description": "The categories assigned to a product.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "CategoryInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "color", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "country_of_manufacture", "description": "The product's country of origin.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "created_at", "description": "Timestamp indicating when the product was created.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "crosssell_products", "description": "Crosssell Products", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "ProductInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": "Detailed information about the product. The value can include simple HTML tags.", "args": [], "type": { "kind": "OBJECT", "name": "ComplexTextValue", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fashion_color", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fashion_material", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fashion_size", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fashion_style", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "format", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "gift_message_available", "description": "Indicates whether a gift message is available.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "has_video", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The ID number assigned to the product.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use the `uid` field instead." }, { "name": "image", "description": "The relative path to the main image on the product page.", "args": [], "type": { "kind": "OBJECT", "name": "ProductImage", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "is_returnable", "description": "Indicates whether the product can be returned", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "manufacturer", "description": "A number representing the product's manufacturer.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "media_gallery", "description": "An array of Media Gallery objects.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "MediaGalleryInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "media_gallery_entries", "description": "An array of MediaGalleryEntry objects.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "MediaGalleryEntry", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use product's `media_gallery` instead" }, { "name": "meta_description", "description": "A brief overview of the product for search results listings, maximum 255 characters.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "meta_keyword", "description": "A comma-separated list of keywords that are visible only to search engines.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "meta_title", "description": "A string that is displayed in the title bar and tab of the browser and in search results lists.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The product name. Customers use this name to identify the product.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "new_from_date", "description": "The beginning date for new product listings, and determines if the product is featured as a new product.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "new_to_date", "description": "The end date for new product listings.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "only_x_left_in_stock", "description": "Product stock only x left count", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "options", "description": "An array of options for a customizable product.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "CustomizableOptionInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "options_container", "description": "If the product has multiple options, determines where they appear on the product page.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "price", "description": "A ProductPrices object, indicating the price of an item.", "args": [], "type": { "kind": "OBJECT", "name": "ProductPrices", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use price_range for product price information." }, { "name": "price_range", "description": "A PriceRange object, indicating the range of prices for the product", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PriceRange", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "price_tiers", "description": "An array of TierPrice objects.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "TierPrice", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_links", "description": "An array of ProductLinks objects.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "ProductLinksInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "rating_summary", "description": "The average of all the ratings given to the product.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "related_products", "description": "Related Products", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "ProductInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "review_count", "description": "The total count of all the reviews given to the product.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "reviews", "description": "The list of products reviews.", "args": [ { "name": "pageSize", "description": "Specifies the maximum number of results to return at once.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": "20" }, { "name": "currentPage", "description": "Specifies which page of results to return.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": "1" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductReviews", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "short_description", "description": "A short description of the product. Its use depends on the theme.", "args": [], "type": { "kind": "OBJECT", "name": "ComplexTextValue", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sku", "description": "A number or code assigned to a product to identify the product, options, price, and manufacturer.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "small_image", "description": "The relative path to the small image, which is used on catalog pages.", "args": [], "type": { "kind": "OBJECT", "name": "ProductImage", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "special_from_date", "description": "The beginning date that a product has a special price.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "special_price", "description": "The discounted price of the product.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "special_to_date", "description": "The end date that a product has a special price.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "staged", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "stock_status", "description": "Stock status of the product", "args": [], "type": { "kind": "ENUM", "name": "ProductStockStatus", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "swatch_image", "description": "The file name of a swatch image", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "thumbnail", "description": "The relative path to the product's thumbnail image.", "args": [], "type": { "kind": "OBJECT", "name": "ProductImage", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "tier_price", "description": "The price when tier pricing is in effect and the items purchased threshold has been reached.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use price_tiers for product tier price information." }, { "name": "tier_prices", "description": "An array of ProductTierPrices objects.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductTierPrices", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use price_tiers for product tier price information." }, { "name": "type_id", "description": "One of simple, virtual, bundle, downloadable, grouped, or configurable.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use __typename instead." }, { "name": "uid", "description": "The unique ID for a `ProductInterface` object.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "updated_at", "description": "Timestamp indicating when the product was updated.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "upsell_products", "description": "Upsell Products", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "ProductInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "url_key", "description": "The part of the URL that identifies the product", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "url_path", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use product's `canonical_url` or url rewrites instead" }, { "name": "url_rewrites", "description": "URL rewrites list", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "UrlRewrite", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "url_suffix", "description": "The part of the product URL that is appended after the url key", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "video_file", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "websites", "description": "An array of websites in which the product is available.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "Website", "ofType": null } }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "weight", "description": "The weight of the item, in units defined by the store.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "ProductInterface", "ofType": null }, { "kind": "INTERFACE", "name": "PhysicalProductInterface", "ofType": null }, { "kind": "INTERFACE", "name": "CustomizableProductInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ProductFilterInput", "description": "ProductFilterInput is deprecated, use @ProductAttributeFilterInput instead. ProductFilterInput 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.", "fields": null, "inputFields": [ { "name": "category_id", "description": "Category ID the product belongs to.", "type": { "kind": "INPUT_OBJECT", "name": "FilterTypeInput", "ofType": null }, "defaultValue": null }, { "name": "country_of_manufacture", "description": "The product's country of origin.", "type": { "kind": "INPUT_OBJECT", "name": "FilterTypeInput", "ofType": null }, "defaultValue": null }, { "name": "created_at", "description": "Timestamp indicating when the product was created.", "type": { "kind": "INPUT_OBJECT", "name": "FilterTypeInput", "ofType": null }, "defaultValue": null }, { "name": "custom_layout", "description": "The name of a custom layout.", "type": { "kind": "INPUT_OBJECT", "name": "FilterTypeInput", "ofType": null }, "defaultValue": null }, { "name": "custom_layout_update", "description": "XML code that is applied as a layout update to the product page.", "type": { "kind": "INPUT_OBJECT", "name": "FilterTypeInput", "ofType": null }, "defaultValue": null }, { "name": "description", "description": "Detailed information about the product. The value can include simple HTML tags.", "type": { "kind": "INPUT_OBJECT", "name": "FilterTypeInput", "ofType": null }, "defaultValue": null }, { "name": "gift_message_available", "description": "Indicates whether a gift message is available.", "type": { "kind": "INPUT_OBJECT", "name": "FilterTypeInput", "ofType": null }, "defaultValue": null }, { "name": "has_options", "description": "Indicates whether additional attributes have been created for the product.", "type": { "kind": "INPUT_OBJECT", "name": "FilterTypeInput", "ofType": null }, "defaultValue": null }, { "name": "image", "description": "The relative path to the main image on the product page.", "type": { "kind": "INPUT_OBJECT", "name": "FilterTypeInput", "ofType": null }, "defaultValue": null }, { "name": "image_label", "description": "The label assigned to a product image.", "type": { "kind": "INPUT_OBJECT", "name": "FilterTypeInput", "ofType": null }, "defaultValue": null }, { "name": "is_returnable", "description": "Indicates whether the product can be returned", "type": { "kind": "INPUT_OBJECT", "name": "FilterTypeInput", "ofType": null }, "defaultValue": null }, { "name": "manufacturer", "description": "A number representing the product's manufacturer.", "type": { "kind": "INPUT_OBJECT", "name": "FilterTypeInput", "ofType": null }, "defaultValue": null }, { "name": "max_price", "description": "The numeric maximal price of the product. Do not include the currency code.", "type": { "kind": "INPUT_OBJECT", "name": "FilterTypeInput", "ofType": null }, "defaultValue": null }, { "name": "meta_description", "description": "A brief overview of the product for search results listings, maximum 255 characters.", "type": { "kind": "INPUT_OBJECT", "name": "FilterTypeInput", "ofType": null }, "defaultValue": null }, { "name": "meta_keyword", "description": "A comma-separated list of keywords that are visible only to search engines.", "type": { "kind": "INPUT_OBJECT", "name": "FilterTypeInput", "ofType": null }, "defaultValue": null }, { "name": "meta_title", "description": "A string that is displayed in the title bar and tab of the browser and in search results lists.", "type": { "kind": "INPUT_OBJECT", "name": "FilterTypeInput", "ofType": null }, "defaultValue": null }, { "name": "min_price", "description": "The numeric minimal price of the product. Do not include the currency code.", "type": { "kind": "INPUT_OBJECT", "name": "FilterTypeInput", "ofType": null }, "defaultValue": null }, { "name": "name", "description": "The product name. Customers use this name to identify the product.", "type": { "kind": "INPUT_OBJECT", "name": "FilterTypeInput", "ofType": null }, "defaultValue": null }, { "name": "news_from_date", "description": "The beginning date for new product listings, and determines if the product is featured as a new product.", "type": { "kind": "INPUT_OBJECT", "name": "FilterTypeInput", "ofType": null }, "defaultValue": null }, { "name": "news_to_date", "description": "The end date for new product listings.", "type": { "kind": "INPUT_OBJECT", "name": "FilterTypeInput", "ofType": null }, "defaultValue": null }, { "name": "options_container", "description": "If the product has multiple options, determines where they appear on the product page.", "type": { "kind": "INPUT_OBJECT", "name": "FilterTypeInput", "ofType": null }, "defaultValue": null }, { "name": "or", "description": "The keyword required to perform a logical OR comparison.", "type": { "kind": "INPUT_OBJECT", "name": "ProductFilterInput", "ofType": null }, "defaultValue": null }, { "name": "price", "description": "The price of an item.", "type": { "kind": "INPUT_OBJECT", "name": "FilterTypeInput", "ofType": null }, "defaultValue": null }, { "name": "required_options", "description": "Indicates whether the product has required options.", "type": { "kind": "INPUT_OBJECT", "name": "FilterTypeInput", "ofType": null }, "defaultValue": null }, { "name": "short_description", "description": "A short description of the product. Its use depends on the theme.", "type": { "kind": "INPUT_OBJECT", "name": "FilterTypeInput", "ofType": null }, "defaultValue": null }, { "name": "sku", "description": "A number or code assigned to a product to identify the product, options, price, and manufacturer.", "type": { "kind": "INPUT_OBJECT", "name": "FilterTypeInput", "ofType": null }, "defaultValue": null }, { "name": "small_image", "description": "The relative path to the small image, which is used on catalog pages.", "type": { "kind": "INPUT_OBJECT", "name": "FilterTypeInput", "ofType": null }, "defaultValue": null }, { "name": "small_image_label", "description": "The label assigned to a product's small image.", "type": { "kind": "INPUT_OBJECT", "name": "FilterTypeInput", "ofType": null }, "defaultValue": null }, { "name": "special_from_date", "description": "The beginning date that a product has a special price.", "type": { "kind": "INPUT_OBJECT", "name": "FilterTypeInput", "ofType": null }, "defaultValue": null }, { "name": "special_price", "description": "The discounted price of the product. Do not include the currency code.", "type": { "kind": "INPUT_OBJECT", "name": "FilterTypeInput", "ofType": null }, "defaultValue": null }, { "name": "special_to_date", "description": "The end date that a product has a special price.", "type": { "kind": "INPUT_OBJECT", "name": "FilterTypeInput", "ofType": null }, "defaultValue": null }, { "name": "swatch_image", "description": "The file name of a swatch image", "type": { "kind": "INPUT_OBJECT", "name": "FilterTypeInput", "ofType": null }, "defaultValue": null }, { "name": "thumbnail", "description": "The relative path to the product's thumbnail image.", "type": { "kind": "INPUT_OBJECT", "name": "FilterTypeInput", "ofType": null }, "defaultValue": null }, { "name": "thumbnail_label", "description": "The label assigned to a product's thumbnail image.", "type": { "kind": "INPUT_OBJECT", "name": "FilterTypeInput", "ofType": null }, "defaultValue": null }, { "name": "tier_price", "description": "The price when tier pricing is in effect and the items purchased threshold has been reached.", "type": { "kind": "INPUT_OBJECT", "name": "FilterTypeInput", "ofType": null }, "defaultValue": null }, { "name": "updated_at", "description": "Timestamp indicating when the product was updated.", "type": { "kind": "INPUT_OBJECT", "name": "FilterTypeInput", "ofType": null }, "defaultValue": null }, { "name": "url_key", "description": "The part of the URL that identifies the product", "type": { "kind": "INPUT_OBJECT", "name": "FilterTypeInput", "ofType": null }, "defaultValue": null }, { "name": "url_path", "description": "", "type": { "kind": "INPUT_OBJECT", "name": "FilterTypeInput", "ofType": null }, "defaultValue": null }, { "name": "weight", "description": "The weight of the item, in units defined by the store.", "type": { "kind": "INPUT_OBJECT", "name": "FilterTypeInput", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "INPUT_OBJECT", "name": "ProductSortInput", "description": "ProductSortInput is deprecated, use @ProductAttributeSortInput instead. ProductSortInput specifies the attribute to use for sorting search results and indicates whether the results are sorted in ascending or descending order.", "fields": null, "inputFields": [ { "name": "country_of_manufacture", "description": "The product's country of origin.", "type": { "kind": "ENUM", "name": "SortEnum", "ofType": null }, "defaultValue": null }, { "name": "created_at", "description": "Timestamp indicating when the product was created.", "type": { "kind": "ENUM", "name": "SortEnum", "ofType": null }, "defaultValue": null }, { "name": "custom_layout", "description": "The name of a custom layout.", "type": { "kind": "ENUM", "name": "SortEnum", "ofType": null }, "defaultValue": null }, { "name": "custom_layout_update", "description": "XML code that is applied as a layout update to the product page.", "type": { "kind": "ENUM", "name": "SortEnum", "ofType": null }, "defaultValue": null }, { "name": "description", "description": "Detailed information about the product. The value can include simple HTML tags.", "type": { "kind": "ENUM", "name": "SortEnum", "ofType": null }, "defaultValue": null }, { "name": "gift_message_available", "description": "Indicates whether a gift message is available.", "type": { "kind": "ENUM", "name": "SortEnum", "ofType": null }, "defaultValue": null }, { "name": "has_options", "description": "Indicates whether additional attributes have been created for the product.", "type": { "kind": "ENUM", "name": "SortEnum", "ofType": null }, "defaultValue": null }, { "name": "image", "description": "The relative path to the main image on the product page.", "type": { "kind": "ENUM", "name": "SortEnum", "ofType": null }, "defaultValue": null }, { "name": "image_label", "description": "The label assigned to a product image.", "type": { "kind": "ENUM", "name": "SortEnum", "ofType": null }, "defaultValue": null }, { "name": "is_returnable", "description": "Indicates whether the product can be returned", "type": { "kind": "ENUM", "name": "SortEnum", "ofType": null }, "defaultValue": null }, { "name": "manufacturer", "description": "A number representing the product's manufacturer.", "type": { "kind": "ENUM", "name": "SortEnum", "ofType": null }, "defaultValue": null }, { "name": "meta_description", "description": "A brief overview of the product for search results listings, maximum 255 characters.", "type": { "kind": "ENUM", "name": "SortEnum", "ofType": null }, "defaultValue": null }, { "name": "meta_keyword", "description": "A comma-separated list of keywords that are visible only to search engines.", "type": { "kind": "ENUM", "name": "SortEnum", "ofType": null }, "defaultValue": null }, { "name": "meta_title", "description": "A string that is displayed in the title bar and tab of the browser and in search results lists.", "type": { "kind": "ENUM", "name": "SortEnum", "ofType": null }, "defaultValue": null }, { "name": "name", "description": "The product name. Customers use this name to identify the product.", "type": { "kind": "ENUM", "name": "SortEnum", "ofType": null }, "defaultValue": null }, { "name": "news_from_date", "description": "The beginning date for new product listings, and determines if the product is featured as a new product.", "type": { "kind": "ENUM", "name": "SortEnum", "ofType": null }, "defaultValue": null }, { "name": "news_to_date", "description": "The end date for new product listings.", "type": { "kind": "ENUM", "name": "SortEnum", "ofType": null }, "defaultValue": null }, { "name": "options_container", "description": "If the product has multiple options, determines where they appear on the product page.", "type": { "kind": "ENUM", "name": "SortEnum", "ofType": null }, "defaultValue": null }, { "name": "price", "description": "The price of the item.", "type": { "kind": "ENUM", "name": "SortEnum", "ofType": null }, "defaultValue": null }, { "name": "required_options", "description": "Indicates whether the product has required options.", "type": { "kind": "ENUM", "name": "SortEnum", "ofType": null }, "defaultValue": null }, { "name": "short_description", "description": "A short description of the product. Its use depends on the theme.", "type": { "kind": "ENUM", "name": "SortEnum", "ofType": null }, "defaultValue": null }, { "name": "sku", "description": "A number or code assigned to a product to identify the product, options, price, and manufacturer.", "type": { "kind": "ENUM", "name": "SortEnum", "ofType": null }, "defaultValue": null }, { "name": "small_image", "description": "The relative path to the small image, which is used on catalog pages.", "type": { "kind": "ENUM", "name": "SortEnum", "ofType": null }, "defaultValue": null }, { "name": "small_image_label", "description": "The label assigned to a product's small image.", "type": { "kind": "ENUM", "name": "SortEnum", "ofType": null }, "defaultValue": null }, { "name": "special_from_date", "description": "The beginning date that a product has a special price.", "type": { "kind": "ENUM", "name": "SortEnum", "ofType": null }, "defaultValue": null }, { "name": "special_price", "description": "The discounted price of the product.", "type": { "kind": "ENUM", "name": "SortEnum", "ofType": null }, "defaultValue": null }, { "name": "special_to_date", "description": "The end date that a product has a special price.", "type": { "kind": "ENUM", "name": "SortEnum", "ofType": null }, "defaultValue": null }, { "name": "swatch_image", "description": "The file name of a swatch image", "type": { "kind": "ENUM", "name": "SortEnum", "ofType": null }, "defaultValue": null }, { "name": "thumbnail", "description": "The relative path to the product's thumbnail image.", "type": { "kind": "ENUM", "name": "SortEnum", "ofType": null }, "defaultValue": null }, { "name": "thumbnail_label", "description": "The label assigned to a product's thumbnail image.", "type": { "kind": "ENUM", "name": "SortEnum", "ofType": null }, "defaultValue": null }, { "name": "tier_price", "description": "The price when tier pricing is in effect and the items purchased threshold has been reached.", "type": { "kind": "ENUM", "name": "SortEnum", "ofType": null }, "defaultValue": null }, { "name": "updated_at", "description": "Timestamp indicating when the product was updated.", "type": { "kind": "ENUM", "name": "SortEnum", "ofType": null }, "defaultValue": null }, { "name": "url_key", "description": "The part of the URL that identifies the product", "type": { "kind": "ENUM", "name": "SortEnum", "ofType": null }, "defaultValue": null }, { "name": "url_path", "description": "", "type": { "kind": "ENUM", "name": "SortEnum", "ofType": null }, "defaultValue": null }, { "name": "weight", "description": "The weight of the item, in units defined by the store.", "type": { "kind": "ENUM", "name": "SortEnum", "ofType": null }, "defaultValue": null } ], "interfaces": null, "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "LayerFilterItem", "description": "", "fields": [ { "name": "items_count", "description": "Count of items by filter.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use AggregationOption.count instead." }, { "name": "label", "description": "Filter label.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use AggregationOption.label instead." }, { "name": "value_string", "description": "Value for filter request variable to be used in query.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use AggregationOption.value instead." } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "LayerFilterItemInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SimpleWishlistItem", "description": "A simple product wish list Item", "fields": [ { "name": "added_at", "description": "The date and time the item was added to the wish list", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customizable_options", "description": "Custom options selected for the wish list item", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "SelectedCustomizableOption", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": "The description of the item", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The unique ID for a `WishlistItemInterface` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product", "description": "Product details of the wish list item", "args": [], "type": { "kind": "INTERFACE", "name": "ProductInterface", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity", "description": "The quantity of this wish list item", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "WishlistItemInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "VirtualWishlistItem", "description": "A virtual product wish list item", "fields": [ { "name": "added_at", "description": "The date and time the item was added to the wish list", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customizable_options", "description": "Custom options selected for the wish list item", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "SelectedCustomizableOption", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": "The description of the item", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The unique ID for a `WishlistItemInterface` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product", "description": "Product details of the wish list item", "args": [], "type": { "kind": "INTERFACE", "name": "ProductInterface", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity", "description": "The quantity of this wish list item", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "WishlistItemInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SimpleCartItem", "description": "Simple Cart Item", "fields": [ { "name": "available_gift_wrapping", "description": "The list of available gift wrapping options for the cart item", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "GiftWrapping", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customizable_options", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "SelectedCustomizableOption", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "gift_message", "description": "The entered gift message for the cart item", "args": [], "type": { "kind": "OBJECT", "name": "GiftMessage", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "gift_wrapping", "description": "The selected gift wrapping for the cart item", "args": [], "type": { "kind": "OBJECT", "name": "GiftWrapping", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `uid` instead" }, { "name": "prices", "description": null, "args": [], "type": { "kind": "OBJECT", "name": "CartItemPrices", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INTERFACE", "name": "ProductInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "uid", "description": "The unique ID for a `CartItemInterface` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "CartItemInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "VirtualCartItem", "description": "Virtual Cart Item", "fields": [ { "name": "customizable_options", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "SelectedCustomizableOption", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `uid` instead" }, { "name": "prices", "description": null, "args": [], "type": { "kind": "OBJECT", "name": "CartItemPrices", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INTERFACE", "name": "ProductInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "uid", "description": "The unique ID for a `CartItemInterface` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "CartItemInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DownloadableCartItem", "description": "Downloadable Cart Item", "fields": [ { "name": "customizable_options", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "SelectedCustomizableOption", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `uid` instead" }, { "name": "links", "description": "An array containing information about the links for the added to cart downloadable product", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "DownloadableProductLinks", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "prices", "description": null, "args": [], "type": { "kind": "OBJECT", "name": "CartItemPrices", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INTERFACE", "name": "ProductInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "samples", "description": "DownloadableProductSamples defines characteristics of a downloadable product", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "DownloadableProductSamples", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "uid", "description": "The unique ID for a `CartItemInterface` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "CartItemInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DownloadableProductLinks", "description": "DownloadableProductLinks defines characteristics of a downloadable product", "fields": [ { "name": "id", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "This information should not be exposed on frontend" }, { "name": "is_shareable", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "isDeprecated": true, "deprecationReason": "This information should not be exposed on frontend" }, { "name": "link_type", "description": null, "args": [], "type": { "kind": "ENUM", "name": "DownloadableFileTypeEnum", "ofType": null }, "isDeprecated": true, "deprecationReason": "`sample_url` serves to get the downloadable sample" }, { "name": "number_of_downloads", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "This information should not be exposed on frontend" }, { "name": "price", "description": "The price of the downloadable product", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sample_file", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "`sample_url` serves to get the downloadable sample" }, { "name": "sample_type", "description": null, "args": [], "type": { "kind": "ENUM", "name": "DownloadableFileTypeEnum", "ofType": null }, "isDeprecated": true, "deprecationReason": "`sample_url` serves to get the downloadable sample" }, { "name": "sample_url", "description": "URL to the downloadable sample", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sort_order", "description": "A number indicating the sort order", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The display name of the link", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "uid", "description": "The unique ID for a `DownloadableProductLinks` object.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "DownloadableFileTypeEnum", "description": "", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "FILE", "description": "", "isDeprecated": true, "deprecationReason": "`sample_url` serves to get the downloadable sample" }, { "name": "URL", "description": "", "isDeprecated": true, "deprecationReason": "`sample_url` serves to get the downloadable sample" } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "DownloadableProductSamples", "description": "DownloadableProductSamples defines characteristics of a downloadable product", "fields": [ { "name": "id", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "This information should not be exposed on frontend" }, { "name": "sample_file", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "`sample_url` serves to get the downloadable sample" }, { "name": "sample_type", "description": null, "args": [], "type": { "kind": "ENUM", "name": "DownloadableFileTypeEnum", "ofType": null }, "isDeprecated": true, "deprecationReason": "`sample_url` serves to get the downloadable sample" }, { "name": "sample_url", "description": "URL to the downloadable sample", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sort_order", "description": "A number indicating the sort order", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The display name of the sample", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DownloadableProduct", "description": "DownloadableProduct defines a product that the customer downloads", "fields": [ { "name": "attribute_set_id", "description": "The attribute set assigned to the product.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "canonical_url", "description": "Relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "categories", "description": "The categories assigned to a product.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "CategoryInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "color", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "country_of_manufacture", "description": "The product's country of origin.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "created_at", "description": "Timestamp indicating when the product was created.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "crosssell_products", "description": "Crosssell Products", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "ProductInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": "Detailed information about the product. The value can include simple HTML tags.", "args": [], "type": { "kind": "OBJECT", "name": "ComplexTextValue", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "downloadable_product_links", "description": "An array containing information about the links for this downloadable product", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "DownloadableProductLinks", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "downloadable_product_samples", "description": "An array containing information about samples of this downloadable product.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "DownloadableProductSamples", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "fashion_color", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fashion_material", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fashion_size", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fashion_style", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "format", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "gift_message_available", "description": "Indicates whether a gift message is available.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "has_video", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The ID number assigned to the product.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use the `uid` field instead." }, { "name": "image", "description": "The relative path to the main image on the product page.", "args": [], "type": { "kind": "OBJECT", "name": "ProductImage", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "is_returnable", "description": "Indicates whether the product can be returned", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "links_purchased_separately", "description": "A value of 1 indicates that each link in the array must be purchased separately", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "links_title", "description": "The heading above the list of downloadable products", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "manufacturer", "description": "A number representing the product's manufacturer.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "media_gallery", "description": "An array of Media Gallery objects.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "MediaGalleryInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "media_gallery_entries", "description": "An array of MediaGalleryEntry objects.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "MediaGalleryEntry", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use product's `media_gallery` instead" }, { "name": "meta_description", "description": "A brief overview of the product for search results listings, maximum 255 characters.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "meta_keyword", "description": "A comma-separated list of keywords that are visible only to search engines.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "meta_title", "description": "A string that is displayed in the title bar and tab of the browser and in search results lists.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The product name. Customers use this name to identify the product.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "new_from_date", "description": "The beginning date for new product listings, and determines if the product is featured as a new product.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "new_to_date", "description": "The end date for new product listings.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "only_x_left_in_stock", "description": "Product stock only x left count", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "options", "description": "An array of options for a customizable product.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "CustomizableOptionInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "options_container", "description": "If the product has multiple options, determines where they appear on the product page.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "price", "description": "A ProductPrices object, indicating the price of an item.", "args": [], "type": { "kind": "OBJECT", "name": "ProductPrices", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use price_range for product price information." }, { "name": "price_range", "description": "A PriceRange object, indicating the range of prices for the product", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PriceRange", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "price_tiers", "description": "An array of TierPrice objects.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "TierPrice", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_links", "description": "An array of ProductLinks objects.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "ProductLinksInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "rating_summary", "description": "The average of all the ratings given to the product.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "related_products", "description": "Related Products", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "ProductInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "review_count", "description": "The total count of all the reviews given to the product.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "reviews", "description": "The list of products reviews.", "args": [ { "name": "pageSize", "description": "Specifies the maximum number of results to return at once.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": "20" }, { "name": "currentPage", "description": "Specifies which page of results to return.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": "1" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductReviews", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "short_description", "description": "A short description of the product. Its use depends on the theme.", "args": [], "type": { "kind": "OBJECT", "name": "ComplexTextValue", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sku", "description": "A number or code assigned to a product to identify the product, options, price, and manufacturer.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "small_image", "description": "The relative path to the small image, which is used on catalog pages.", "args": [], "type": { "kind": "OBJECT", "name": "ProductImage", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "special_from_date", "description": "The beginning date that a product has a special price.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "special_price", "description": "The discounted price of the product.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "special_to_date", "description": "The end date that a product has a special price.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "staged", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "stock_status", "description": "Stock status of the product", "args": [], "type": { "kind": "ENUM", "name": "ProductStockStatus", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "swatch_image", "description": "The file name of a swatch image", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "thumbnail", "description": "The relative path to the product's thumbnail image.", "args": [], "type": { "kind": "OBJECT", "name": "ProductImage", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "tier_price", "description": "The price when tier pricing is in effect and the items purchased threshold has been reached.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use price_tiers for product tier price information." }, { "name": "tier_prices", "description": "An array of ProductTierPrices objects.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductTierPrices", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use price_tiers for product tier price information." }, { "name": "type_id", "description": "One of simple, virtual, bundle, downloadable, grouped, or configurable.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use __typename instead." }, { "name": "uid", "description": "The unique ID for a `ProductInterface` object.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "updated_at", "description": "Timestamp indicating when the product was updated.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "upsell_products", "description": "Upsell Products", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "ProductInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "url_key", "description": "The part of the URL that identifies the product", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "url_path", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use product's `canonical_url` or url rewrites instead" }, { "name": "url_rewrites", "description": "URL rewrites list", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "UrlRewrite", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "url_suffix", "description": "The part of the product URL that is appended after the url key", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "video_file", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "websites", "description": "An array of websites in which the product is available.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "Website", "ofType": null } }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "ProductInterface", "ofType": null }, { "kind": "INTERFACE", "name": "CustomizableProductInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DownloadableOrderItem", "description": "", "fields": [ { "name": "discounts", "description": "The final discount information for the product", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "Discount", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "downloadable_links", "description": "A list of downloadable links that are ordered from the downloadable product", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "DownloadableItemsLinks", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "eligible_for_return", "description": "Indicates whether the order item is eligible is eligible to be in a return request", "args": [], "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "entered_options", "description": "The entered option for the base product, such as a logo or image", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "OrderItemOption", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "gift_wrapping", "description": "The selected gift wrapping for the order item", "args": [], "type": { "kind": "OBJECT", "name": "GiftWrapping", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The unique ID for a `OrderItemInterface` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_name", "description": "The name of the base product", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_sale_price", "description": "The sale price of the base product, including selected options", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_sku", "description": "The SKU of the base product", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_type", "description": "The type of product, such as simple, configurable, etc.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_url_key", "description": "URL key of the base product", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity_canceled", "description": "The number of canceled items", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity_invoiced", "description": "The number of invoiced items", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity_ordered", "description": "The number of units ordered for this item", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity_refunded", "description": "The number of refunded items", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity_returned", "description": "The number of returned items", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity_shipped", "description": "The number of shipped items", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "selected_options", "description": "The selected options for the base product, such as color or size", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "OrderItemOption", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "The status of the order item", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "OrderItemInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DownloadableItemsLinks", "description": "DownloadableProductLinks defines characteristics of a downloadable product", "fields": [ { "name": "sort_order", "description": "A number indicating the sort order", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The display name of the link", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "uid", "description": "The unique ID for a `DownloadableItemsLinks` object.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DownloadableInvoiceItem", "description": "", "fields": [ { "name": "discounts", "description": "Contains information about the final discount amount for the base product, including discounts on options", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "Discount", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "downloadable_links", "description": "A list of downloadable links that are invoiced from the downloadable product", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "DownloadableItemsLinks", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The unique ID for a `InvoiceItemInterface` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "order_item", "description": "Contains details about an individual order item", "args": [], "type": { "kind": "INTERFACE", "name": "OrderItemInterface", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_name", "description": "The name of the base product", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_sale_price", "description": "The sale price for the base product including selected options", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_sku", "description": "The SKU of the base product", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity_invoiced", "description": "The number of invoiced items", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "InvoiceItemInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DownloadableCreditMemoItem", "description": "", "fields": [ { "name": "discounts", "description": "Contains information about the final discount amount for the base product, including discounts on options", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "Discount", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "downloadable_links", "description": "A list of downloadable links that are refunded from the downloadable product", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "DownloadableItemsLinks", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The unique ID for a `CreditMemoItemInterface` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "order_item", "description": "The order item the credit memo is applied to", "args": [], "type": { "kind": "INTERFACE", "name": "OrderItemInterface", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_name", "description": "The name of the base product", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_sale_price", "description": "The sale price for the base product, including selected options", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_sku", "description": "SKU of the base product", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity_refunded", "description": "The number of refunded items", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "CreditMemoItemInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "DownloadableWishlistItem", "description": "A downloadable product wish list item", "fields": [ { "name": "added_at", "description": "The date and time the item was added to the wish list", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customizable_options", "description": "Custom options selected for the wish list item", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "SelectedCustomizableOption", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": "The description of the item", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The unique ID for a `WishlistItemInterface` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "links_v2", "description": "An array containing information about the selected links", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "DownloadableProductLinks", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product", "description": "Product details of the wish list item", "args": [], "type": { "kind": "INTERFACE", "name": "ProductInterface", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity", "description": "The quantity of this wish list item", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "samples", "description": "An array containing information about the selected samples", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "DownloadableProductSamples", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "WishlistItemInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ConfigurableCartItem", "description": "", "fields": [ { "name": "available_gift_wrapping", "description": "The list of available gift wrapping options for the cart item", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "GiftWrapping", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "configurable_options", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "SelectedConfigurableOption", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customizable_options", "description": null, "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "SelectedCustomizableOption", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "gift_message", "description": "The entered gift message for the cart item", "args": [], "type": { "kind": "OBJECT", "name": "GiftMessage", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "gift_wrapping", "description": "The selected gift wrapping for the cart item", "args": [], "type": { "kind": "OBJECT", "name": "GiftWrapping", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `uid` instead" }, { "name": "prices", "description": null, "args": [], "type": { "kind": "OBJECT", "name": "CartItemPrices", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INTERFACE", "name": "ProductInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "uid", "description": "The unique ID for a `CartItemInterface` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "CartItemInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SelectedConfigurableOption", "description": "", "fields": [ { "name": "configurable_product_option_uid", "description": "The unique ID for a `ConfigurableProductOptions` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "configurable_product_option_value_uid", "description": "The unique ID for a `ConfigurableProductOptionsValues` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use SelectedConfigurableOption.configurable_product_option_uid instead" }, { "name": "option_label", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "value_id", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use SelectedConfigurableOption.configurable_product_option_value_uid instead" }, { "name": "value_label", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "BundleCartItem", "description": "", "fields": [ { "name": "available_gift_wrapping", "description": "The list of available gift wrapping options for the cart item", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "GiftWrapping", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "bundle_options", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "SelectedBundleOption", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customizable_options", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "SelectedCustomizableOption", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "gift_message", "description": "The entered gift message for the cart item", "args": [], "type": { "kind": "OBJECT", "name": "GiftMessage", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "gift_wrapping", "description": "The selected gift wrapping for the cart item", "args": [], "type": { "kind": "OBJECT", "name": "GiftWrapping", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `uid` instead" }, { "name": "prices", "description": null, "args": [], "type": { "kind": "OBJECT", "name": "CartItemPrices", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INTERFACE", "name": "ProductInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "uid", "description": "The unique ID for a `CartItemInterface` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "CartItemInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SelectedBundleOption", "description": "", "fields": [ { "name": "id", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `uid` instead" }, { "name": "label", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "type", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "uid", "description": "The unique ID for a `SelectedBundleOption` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "values", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "SelectedBundleOptionValue", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SelectedBundleOptionValue", "description": "", "fields": [ { "name": "id", "description": "Use `uid` instead", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "label", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "price", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "uid", "description": "The unique ID for a `SelectedBundleOptionValue` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SalesItemInterface", "description": "", "fields": [ { "name": "gift_message", "description": "The entered gift message for the order item", "args": [], "type": { "kind": "OBJECT", "name": "GiftMessage", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "BundleItem", "description": "BundleItem defines an individual item in a bundle product.", "fields": [ { "name": "option_id", "description": "An ID assigned to each type of item in a bundle product.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `uid` instead" }, { "name": "options", "description": "An array of additional options for this bundle item.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "BundleItemOption", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "position", "description": "he relative position of this item compared to the other bundle items.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "required", "description": "Indicates whether the item must be included in the bundle.", "args": [], "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sku", "description": "The SKU of the bundle product.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "title", "description": "The display name of the item.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "type", "description": "The input type that the customer uses to select the item. Examples include radio button and checkbox.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "uid", "description": "The unique ID for a `BundleItem` object.", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "BundleItemOption", "description": "BundleItemOption defines characteristics and options for a specific bundle item.", "fields": [ { "name": "can_change_quantity", "description": "Indicates whether the customer can change the number of items for this option.", "args": [], "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The ID assigned to the bundled item option.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `uid` instead" }, { "name": "is_default", "description": "Indicates whether this option is the default option.", "args": [], "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "label", "description": "The text that identifies the bundled item option.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "position", "description": "When a bundle item contains multiple options, the relative position of this option compared to the other options.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "price", "description": "The price of the selected option.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "price_type", "description": "One of FIXED, PERCENT, or DYNAMIC.", "args": [], "type": { "kind": "ENUM", "name": "PriceTypeEnum", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product", "description": "Contains details about this product option.", "args": [], "type": { "kind": "INTERFACE", "name": "ProductInterface", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "qty", "description": "Indicates the quantity of this specific bundle item.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": true, "deprecationReason": "The `qty` is deprecated. Use `quantity` instead." }, { "name": "quantity", "description": "Indicates the quantity of this specific bundle item.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "uid", "description": "The unique ID for a `BundleItemOption` object.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "BundleProduct", "description": "BundleProduct defines basic features of a bundle product and contains multiple BundleItems.", "fields": [ { "name": "attribute_set_id", "description": "The attribute set assigned to the product.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "canonical_url", "description": "Relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "categories", "description": "The categories assigned to a product.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "CategoryInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "color", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "country_of_manufacture", "description": "The product's country of origin.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "created_at", "description": "Timestamp indicating when the product was created.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "crosssell_products", "description": "Crosssell Products", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "ProductInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": "Detailed information about the product. The value can include simple HTML tags.", "args": [], "type": { "kind": "OBJECT", "name": "ComplexTextValue", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "dynamic_price", "description": "Indicates whether the bundle product has a dynamic price.", "args": [], "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "dynamic_sku", "description": "Indicates whether the bundle product has a dynamic SK.", "args": [], "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "dynamic_weight", "description": "Indicates whether the bundle product has a dynamically calculated weight.", "args": [], "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fashion_color", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fashion_material", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fashion_size", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fashion_style", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "format", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "gift_message_available", "description": "Indicates whether a gift message is available.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "has_video", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The ID number assigned to the product.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use the `uid` field instead." }, { "name": "image", "description": "The relative path to the main image on the product page.", "args": [], "type": { "kind": "OBJECT", "name": "ProductImage", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "is_returnable", "description": "Indicates whether the product can be returned", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "items", "description": "An array containing information about individual bundle items.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "BundleItem", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "manufacturer", "description": "A number representing the product's manufacturer.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "media_gallery", "description": "An array of Media Gallery objects.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "MediaGalleryInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "media_gallery_entries", "description": "An array of MediaGalleryEntry objects.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "MediaGalleryEntry", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use product's `media_gallery` instead" }, { "name": "meta_description", "description": "A brief overview of the product for search results listings, maximum 255 characters.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "meta_keyword", "description": "A comma-separated list of keywords that are visible only to search engines.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "meta_title", "description": "A string that is displayed in the title bar and tab of the browser and in search results lists.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The product name. Customers use this name to identify the product.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "new_from_date", "description": "The beginning date for new product listings, and determines if the product is featured as a new product.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "new_to_date", "description": "The end date for new product listings.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "only_x_left_in_stock", "description": "Product stock only x left count", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "options", "description": "An array of options for a customizable product.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "CustomizableOptionInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "options_container", "description": "If the product has multiple options, determines where they appear on the product page.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "price", "description": "A ProductPrices object, indicating the price of an item.", "args": [], "type": { "kind": "OBJECT", "name": "ProductPrices", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use price_range for product price information." }, { "name": "price_range", "description": "A PriceRange object, indicating the range of prices for the product", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PriceRange", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "price_tiers", "description": "An array of TierPrice objects.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "TierPrice", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "price_view", "description": "One of PRICE_RANGE or AS_LOW_AS.", "args": [], "type": { "kind": "ENUM", "name": "PriceViewEnum", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_links", "description": "An array of ProductLinks objects.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "ProductLinksInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "rating_summary", "description": "The average of all the ratings given to the product.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "related_products", "description": "Related Products", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "ProductInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "review_count", "description": "The total count of all the reviews given to the product.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "reviews", "description": "The list of products reviews.", "args": [ { "name": "pageSize", "description": "Specifies the maximum number of results to return at once.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": "20" }, { "name": "currentPage", "description": "Specifies which page of results to return.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": "1" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductReviews", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "ship_bundle_items", "description": "Indicates whether to ship bundle items together or individually.", "args": [], "type": { "kind": "ENUM", "name": "ShipBundleItemsEnum", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "short_description", "description": "A short description of the product. Its use depends on the theme.", "args": [], "type": { "kind": "OBJECT", "name": "ComplexTextValue", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sku", "description": "A number or code assigned to a product to identify the product, options, price, and manufacturer.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "small_image", "description": "The relative path to the small image, which is used on catalog pages.", "args": [], "type": { "kind": "OBJECT", "name": "ProductImage", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "special_from_date", "description": "The beginning date that a product has a special price.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "special_price", "description": "The discounted price of the product.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "special_to_date", "description": "The end date that a product has a special price.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "staged", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "stock_status", "description": "Stock status of the product", "args": [], "type": { "kind": "ENUM", "name": "ProductStockStatus", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "swatch_image", "description": "The file name of a swatch image", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "thumbnail", "description": "The relative path to the product's thumbnail image.", "args": [], "type": { "kind": "OBJECT", "name": "ProductImage", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "tier_price", "description": "The price when tier pricing is in effect and the items purchased threshold has been reached.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use price_tiers for product tier price information." }, { "name": "tier_prices", "description": "An array of ProductTierPrices objects.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductTierPrices", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use price_tiers for product tier price information." }, { "name": "type_id", "description": "One of simple, virtual, bundle, downloadable, grouped, or configurable.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use __typename instead." }, { "name": "uid", "description": "The unique ID for a `ProductInterface` object.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "updated_at", "description": "Timestamp indicating when the product was updated.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "upsell_products", "description": "Upsell Products", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "ProductInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "url_key", "description": "The part of the URL that identifies the product", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "url_path", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use product's `canonical_url` or url rewrites instead" }, { "name": "url_rewrites", "description": "URL rewrites list", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "UrlRewrite", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "url_suffix", "description": "The part of the product URL that is appended after the url key", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "video_file", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "websites", "description": "An array of websites in which the product is available.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "Website", "ofType": null } }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "weight", "description": "The weight of the item, in units defined by the store.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "ProductInterface", "ofType": null }, { "kind": "INTERFACE", "name": "PhysicalProductInterface", "ofType": null }, { "kind": "INTERFACE", "name": "CustomizableProductInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "PriceViewEnum", "description": "This enumeration defines whether a bundle product's price is displayed as the lowest possible value or as a range.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "PRICE_RANGE", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "AS_LOW_AS", "description": "", "isDeprecated": false, "deprecationReason": "" } ], "possibleTypes": null }, { "kind": "ENUM", "name": "ShipBundleItemsEnum", "description": "This enumeration defines whether bundle items must be shipped together.", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "TOGETHER", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "SEPARATELY", "description": "", "isDeprecated": false, "deprecationReason": "" } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "BundleOrderItem", "description": "", "fields": [ { "name": "bundle_options", "description": "A list of bundle options that are assigned to the bundle product", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "ItemSelectedBundleOption", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discounts", "description": "The final discount information for the product", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "Discount", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "eligible_for_return", "description": "Indicates whether the order item is eligible is eligible to be in a return request", "args": [], "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "entered_options", "description": "The entered option for the base product, such as a logo or image", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "OrderItemOption", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "gift_wrapping", "description": "The selected gift wrapping for the order item", "args": [], "type": { "kind": "OBJECT", "name": "GiftWrapping", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The unique ID for a `OrderItemInterface` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_name", "description": "The name of the base product", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_sale_price", "description": "The sale price of the base product, including selected options", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_sku", "description": "The SKU of the base product", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_type", "description": "The type of product, such as simple, configurable, etc.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_url_key", "description": "URL key of the base product", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity_canceled", "description": "The number of canceled items", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity_invoiced", "description": "The number of invoiced items", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity_ordered", "description": "The number of units ordered for this item", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity_refunded", "description": "The number of refunded items", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity_returned", "description": "The number of returned items", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity_shipped", "description": "The number of shipped items", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "selected_options", "description": "The selected options for the base product, such as color or size", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "OrderItemOption", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "The status of the order item", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "OrderItemInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ItemSelectedBundleOption", "description": "A list of options of the selected bundle product", "fields": [ { "name": "id", "description": "The unique ID for a `ItemSelectedBundleOption` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `uid` instead" }, { "name": "label", "description": "The label of the option", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "uid", "description": "The unique ID for a `ItemSelectedBundleOption` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "values", "description": "A list of products that represent the values of the parent option", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "ItemSelectedBundleOptionValue", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ItemSelectedBundleOptionValue", "description": "A list of values for the selected bundle product", "fields": [ { "name": "id", "description": "The unique ID for a `ItemSelectedBundleOptionValue` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `uid` instead" }, { "name": "price", "description": "The price of the child bundle product", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_name", "description": "The name of the child bundle product", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_sku", "description": "The SKU of the child bundle product", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity", "description": "Indicates how many of this bundle product were ordered", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "uid", "description": "The unique ID for a `ItemSelectedBundleOptionValue` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "BundleInvoiceItem", "description": "", "fields": [ { "name": "bundle_options", "description": "A list of bundle options that are assigned to the bundle product", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "ItemSelectedBundleOption", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discounts", "description": "Contains information about the final discount amount for the base product, including discounts on options", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "Discount", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The unique ID for a `InvoiceItemInterface` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "order_item", "description": "Contains details about an individual order item", "args": [], "type": { "kind": "INTERFACE", "name": "OrderItemInterface", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_name", "description": "The name of the base product", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_sale_price", "description": "The sale price for the base product including selected options", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_sku", "description": "The SKU of the base product", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity_invoiced", "description": "The number of invoiced items", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "InvoiceItemInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "BundleShipmentItem", "description": "", "fields": [ { "name": "bundle_options", "description": "A list of bundle options that are assigned to the bundle product", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "ItemSelectedBundleOption", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The unique ID for a `ShipmentItemInterface` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "order_item", "description": "Associated order item", "args": [], "type": { "kind": "INTERFACE", "name": "OrderItemInterface", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_name", "description": "Name of the base product", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_sale_price", "description": "Sale price for the base product", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_sku", "description": "SKU of the base product", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity_shipped", "description": "Number of shipped items", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "ShipmentItemInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "BundleCreditMemoItem", "description": "", "fields": [ { "name": "bundle_options", "description": "A list of bundle options that are assigned to the bundle product", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "ItemSelectedBundleOption", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "discounts", "description": "Contains information about the final discount amount for the base product, including discounts on options", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "Discount", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The unique ID for a `CreditMemoItemInterface` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "order_item", "description": "The order item the credit memo is applied to", "args": [], "type": { "kind": "INTERFACE", "name": "OrderItemInterface", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_name", "description": "The name of the base product", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_sale_price", "description": "The sale price for the base product, including selected options", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_sku", "description": "SKU of the base product", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity_refunded", "description": "The number of refunded items", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "CreditMemoItemInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "BundleWishlistItem", "description": "", "fields": [ { "name": "added_at", "description": "The date and time the item was added to the wish list", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "bundle_options", "description": "An array containing information about the selected bundle items", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "SelectedBundleOption", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customizable_options", "description": "Custom options selected for the wish list item", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "SelectedCustomizableOption", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": "The description of the item", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The unique ID for a `WishlistItemInterface` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product", "description": "Product details of the wish list item", "args": [], "type": { "kind": "INTERFACE", "name": "ProductInterface", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity", "description": "The quantity of this wish list item", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "WishlistItemInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "GroupedProduct", "description": "GroupedProduct defines a grouped product", "fields": [ { "name": "attribute_set_id", "description": "The attribute set assigned to the product.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "canonical_url", "description": "Relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "categories", "description": "The categories assigned to a product.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "CategoryInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "color", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "country_of_manufacture", "description": "The product's country of origin.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "created_at", "description": "Timestamp indicating when the product was created.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "crosssell_products", "description": "Crosssell Products", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "ProductInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": "Detailed information about the product. The value can include simple HTML tags.", "args": [], "type": { "kind": "OBJECT", "name": "ComplexTextValue", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fashion_color", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fashion_material", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fashion_size", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fashion_style", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "format", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "gift_message_available", "description": "Indicates whether a gift message is available.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "has_video", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The ID number assigned to the product.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use the `uid` field instead." }, { "name": "image", "description": "The relative path to the main image on the product page.", "args": [], "type": { "kind": "OBJECT", "name": "ProductImage", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "is_returnable", "description": "Indicates whether the product can be returned", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "items", "description": "An array containing grouped product items", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "GroupedProductItem", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "manufacturer", "description": "A number representing the product's manufacturer.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "media_gallery", "description": "An array of Media Gallery objects.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "MediaGalleryInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "media_gallery_entries", "description": "An array of MediaGalleryEntry objects.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "MediaGalleryEntry", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use product's `media_gallery` instead" }, { "name": "meta_description", "description": "A brief overview of the product for search results listings, maximum 255 characters.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "meta_keyword", "description": "A comma-separated list of keywords that are visible only to search engines.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "meta_title", "description": "A string that is displayed in the title bar and tab of the browser and in search results lists.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The product name. Customers use this name to identify the product.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "new_from_date", "description": "The beginning date for new product listings, and determines if the product is featured as a new product.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "new_to_date", "description": "The end date for new product listings.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "only_x_left_in_stock", "description": "Product stock only x left count", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "options_container", "description": "If the product has multiple options, determines where they appear on the product page.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "price", "description": "A ProductPrices object, indicating the price of an item.", "args": [], "type": { "kind": "OBJECT", "name": "ProductPrices", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use price_range for product price information." }, { "name": "price_range", "description": "A PriceRange object, indicating the range of prices for the product", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PriceRange", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "price_tiers", "description": "An array of TierPrice objects.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "TierPrice", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_links", "description": "An array of ProductLinks objects.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "ProductLinksInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "rating_summary", "description": "The average of all the ratings given to the product.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "related_products", "description": "Related Products", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "ProductInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "review_count", "description": "The total count of all the reviews given to the product.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "reviews", "description": "The list of products reviews.", "args": [ { "name": "pageSize", "description": "Specifies the maximum number of results to return at once.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": "20" }, { "name": "currentPage", "description": "Specifies which page of results to return.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": "1" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductReviews", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "short_description", "description": "A short description of the product. Its use depends on the theme.", "args": [], "type": { "kind": "OBJECT", "name": "ComplexTextValue", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sku", "description": "A number or code assigned to a product to identify the product, options, price, and manufacturer.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "small_image", "description": "The relative path to the small image, which is used on catalog pages.", "args": [], "type": { "kind": "OBJECT", "name": "ProductImage", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "special_from_date", "description": "The beginning date that a product has a special price.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "special_price", "description": "The discounted price of the product.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "special_to_date", "description": "The end date that a product has a special price.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "staged", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "stock_status", "description": "Stock status of the product", "args": [], "type": { "kind": "ENUM", "name": "ProductStockStatus", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "swatch_image", "description": "The file name of a swatch image", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "thumbnail", "description": "The relative path to the product's thumbnail image.", "args": [], "type": { "kind": "OBJECT", "name": "ProductImage", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "tier_price", "description": "The price when tier pricing is in effect and the items purchased threshold has been reached.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use price_tiers for product tier price information." }, { "name": "tier_prices", "description": "An array of ProductTierPrices objects.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductTierPrices", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use price_tiers for product tier price information." }, { "name": "type_id", "description": "One of simple, virtual, bundle, downloadable, grouped, or configurable.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use __typename instead." }, { "name": "uid", "description": "The unique ID for a `ProductInterface` object.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "updated_at", "description": "Timestamp indicating when the product was updated.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "upsell_products", "description": "Upsell Products", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "ProductInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "url_key", "description": "The part of the URL that identifies the product", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "url_path", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use product's `canonical_url` or url rewrites instead" }, { "name": "url_rewrites", "description": "URL rewrites list", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "UrlRewrite", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "url_suffix", "description": "The part of the product URL that is appended after the url key", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "video_file", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "websites", "description": "An array of websites in which the product is available.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "Website", "ofType": null } }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "weight", "description": "The weight of the item, in units defined by the store.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "ProductInterface", "ofType": null }, { "kind": "INTERFACE", "name": "PhysicalProductInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "GroupedProductItem", "description": "GroupedProductItem contains information about an individual grouped product item", "fields": [ { "name": "position", "description": "The relative position of this item compared to the other group items", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product", "description": "The ProductInterface object, which contains details about this product option", "args": [], "type": { "kind": "INTERFACE", "name": "ProductInterface", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "qty", "description": "The quantity of this grouped product item", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "GroupedProductWishlistItem", "description": "A grouped product wish list item", "fields": [ { "name": "added_at", "description": "The date and time the item was added to the wish list", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customizable_options", "description": "Custom options selected for the wish list item", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "SelectedCustomizableOption", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": "The description of the item", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The unique ID for a `WishlistItemInterface` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product", "description": "Product details of the wish list item", "args": [], "type": { "kind": "INTERFACE", "name": "ProductInterface", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity", "description": "The quantity of this wish list item", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "WishlistItemInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "OrderItem", "description": "", "fields": [ { "name": "discounts", "description": "The final discount information for the product", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "Discount", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "eligible_for_return", "description": "Indicates whether the order item is eligible is eligible to be in a return request", "args": [], "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "entered_options", "description": "The entered option for the base product, such as a logo or image", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "OrderItemOption", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "gift_wrapping", "description": "The selected gift wrapping for the order item", "args": [], "type": { "kind": "OBJECT", "name": "GiftWrapping", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The unique ID for a `OrderItemInterface` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_name", "description": "The name of the base product", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_sale_price", "description": "The sale price of the base product, including selected options", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_sku", "description": "The SKU of the base product", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_type", "description": "The type of product, such as simple, configurable, etc.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_url_key", "description": "URL key of the base product", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity_canceled", "description": "The number of canceled items", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity_invoiced", "description": "The number of invoiced items", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity_ordered", "description": "The number of units ordered for this item", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity_refunded", "description": "The number of refunded items", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity_returned", "description": "The number of returned items", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity_shipped", "description": "The number of shipped items", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "selected_options", "description": "The selected options for the base product, such as color or size", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "OrderItemOption", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "The status of the order item", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "OrderItemInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "InvoiceItem", "description": "", "fields": [ { "name": "discounts", "description": "Contains information about the final discount amount for the base product, including discounts on options", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "Discount", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The unique ID for a `InvoiceItemInterface` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "order_item", "description": "Contains details about an individual order item", "args": [], "type": { "kind": "INTERFACE", "name": "OrderItemInterface", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_name", "description": "The name of the base product", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_sale_price", "description": "The sale price for the base product including selected options", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_sku", "description": "The SKU of the base product", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity_invoiced", "description": "The number of invoiced items", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "InvoiceItemInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ShipmentItem", "description": "", "fields": [ { "name": "id", "description": "The unique ID for a `ShipmentItemInterface` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "order_item", "description": "Associated order item", "args": [], "type": { "kind": "INTERFACE", "name": "OrderItemInterface", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_name", "description": "Name of the base product", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_sale_price", "description": "Sale price for the base product", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_sku", "description": "SKU of the base product", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity_shipped", "description": "Number of shipped items", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "ShipmentItemInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "CreditMemoItem", "description": "", "fields": [ { "name": "discounts", "description": "Contains information about the final discount amount for the base product, including discounts on options", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "Discount", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The unique ID for a `CreditMemoItemInterface` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "order_item", "description": "The order item the credit memo is applied to", "args": [], "type": { "kind": "INTERFACE", "name": "OrderItemInterface", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_name", "description": "The name of the base product", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_sale_price", "description": "The sale price for the base product, including selected options", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_sku", "description": "SKU of the base product", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity_refunded", "description": "The number of refunded items", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "CreditMemoItemInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PaypalExpressToken", "description": "Deprecated: use type `PaypalExpressTokenOutput` instead", "fields": [ { "name": "paypal_urls", "description": "A set of URLs that allow the buyer to authorize payment and adjust checkout details", "args": [], "type": { "kind": "OBJECT", "name": "PaypalExpressUrlList", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use field `paypal_urls` of type `PaypalExpressTokenOutput` instead" }, { "name": "token", "description": "The token returned by PayPal", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use field `token` of type `PaypalExpressTokenOutput` instead" } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "PayflowProToken", "description": "Contains the secure information used to authorize transaction. Applies to Payflow Pro and Payments Pro payment methods.", "fields": [ { "name": "response_message", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "result", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "result_code", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "secure_token", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "secure_token_id", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ConfigurableProduct", "description": "ConfigurableProduct defines basic features of a configurable product and its simple product variants", "fields": [ { "name": "attribute_set_id", "description": "The attribute set assigned to the product.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "canonical_url", "description": "Relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "categories", "description": "The categories assigned to a product.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "CategoryInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "color", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "configurable_options", "description": "An array of linked simple product items", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "ConfigurableProductOptions", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "configurable_product_options_selection", "description": "Metadata for the specified configurable options selection", "args": [ { "name": "configurableOptionValueUids", "description": "", "type": { "kind": "LIST", "name": null, "ofType": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "defaultValue": null } ], "type": { "kind": "OBJECT", "name": "ConfigurableProductOptionsSelection", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "country_of_manufacture", "description": "The product's country of origin.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "created_at", "description": "Timestamp indicating when the product was created.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "crosssell_products", "description": "Crosssell Products", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "ProductInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": "Detailed information about the product. The value can include simple HTML tags.", "args": [], "type": { "kind": "OBJECT", "name": "ComplexTextValue", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fashion_color", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fashion_material", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fashion_size", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fashion_style", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "format", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "gift_message_available", "description": "Indicates whether a gift message is available.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "has_video", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The ID number assigned to the product.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use the `uid` field instead." }, { "name": "image", "description": "The relative path to the main image on the product page.", "args": [], "type": { "kind": "OBJECT", "name": "ProductImage", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "is_returnable", "description": "Indicates whether the product can be returned", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "manufacturer", "description": "A number representing the product's manufacturer.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "media_gallery", "description": "An array of Media Gallery objects.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "MediaGalleryInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "media_gallery_entries", "description": "An array of MediaGalleryEntry objects.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "MediaGalleryEntry", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use product's `media_gallery` instead" }, { "name": "meta_description", "description": "A brief overview of the product for search results listings, maximum 255 characters.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "meta_keyword", "description": "A comma-separated list of keywords that are visible only to search engines.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "meta_title", "description": "A string that is displayed in the title bar and tab of the browser and in search results lists.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The product name. Customers use this name to identify the product.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "new_from_date", "description": "The beginning date for new product listings, and determines if the product is featured as a new product.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "new_to_date", "description": "The end date for new product listings.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "only_x_left_in_stock", "description": "Product stock only x left count", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "options", "description": "An array of options for a customizable product.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "CustomizableOptionInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "options_container", "description": "If the product has multiple options, determines where they appear on the product page.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "price", "description": "A ProductPrices object, indicating the price of an item.", "args": [], "type": { "kind": "OBJECT", "name": "ProductPrices", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use price_range for product price information." }, { "name": "price_range", "description": "A PriceRange object, indicating the range of prices for the product", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PriceRange", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "price_tiers", "description": "An array of TierPrice objects.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "TierPrice", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_links", "description": "An array of ProductLinks objects.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "ProductLinksInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "rating_summary", "description": "The average of all the ratings given to the product.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "related_products", "description": "Related Products", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "ProductInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "review_count", "description": "The total count of all the reviews given to the product.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "reviews", "description": "The list of products reviews.", "args": [ { "name": "pageSize", "description": "Specifies the maximum number of results to return at once.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": "20" }, { "name": "currentPage", "description": "Specifies which page of results to return.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": "1" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductReviews", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "short_description", "description": "A short description of the product. Its use depends on the theme.", "args": [], "type": { "kind": "OBJECT", "name": "ComplexTextValue", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sku", "description": "A number or code assigned to a product to identify the product, options, price, and manufacturer.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "small_image", "description": "The relative path to the small image, which is used on catalog pages.", "args": [], "type": { "kind": "OBJECT", "name": "ProductImage", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "special_from_date", "description": "The beginning date that a product has a special price.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "special_price", "description": "The discounted price of the product.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "special_to_date", "description": "The end date that a product has a special price.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "staged", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "stock_status", "description": "Stock status of the product", "args": [], "type": { "kind": "ENUM", "name": "ProductStockStatus", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "swatch_image", "description": "The file name of a swatch image", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "thumbnail", "description": "The relative path to the product's thumbnail image.", "args": [], "type": { "kind": "OBJECT", "name": "ProductImage", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "tier_price", "description": "The price when tier pricing is in effect and the items purchased threshold has been reached.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use price_tiers for product tier price information." }, { "name": "tier_prices", "description": "An array of ProductTierPrices objects.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductTierPrices", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use price_tiers for product tier price information." }, { "name": "type_id", "description": "One of simple, virtual, bundle, downloadable, grouped, or configurable.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use __typename instead." }, { "name": "uid", "description": "The unique ID for a `ProductInterface` object.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "updated_at", "description": "Timestamp indicating when the product was updated.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "upsell_products", "description": "Upsell Products", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "ProductInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "url_key", "description": "The part of the URL that identifies the product", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "url_path", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use product's `canonical_url` or url rewrites instead" }, { "name": "url_rewrites", "description": "URL rewrites list", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "UrlRewrite", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "url_suffix", "description": "The part of the product URL that is appended after the url key", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "variants", "description": "An array of variants of products", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "ConfigurableVariant", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "video_file", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "websites", "description": "An array of websites in which the product is available.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "Website", "ofType": null } }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "weight", "description": "The weight of the item, in units defined by the store.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "ProductInterface", "ofType": null }, { "kind": "INTERFACE", "name": "PhysicalProductInterface", "ofType": null }, { "kind": "INTERFACE", "name": "CustomizableProductInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ConfigurableProductOptions", "description": "ConfigurableProductOptions defines configurable attributes for the specified product", "fields": [ { "name": "attribute_code", "description": "A string that identifies the attribute", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "attribute_id", "description": "The ID assigned to the attribute", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use attribute_uid instead" }, { "name": "attribute_id_v2", "description": "The ID assigned to the attribute", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use attribute_uid instead" }, { "name": "attribute_uid", "description": "The unique ID for a `Attribute` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The configurable option ID number assigned by the system", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use uid instead" }, { "name": "label", "description": "A string that describes the configurable product option, which is displayed on the UI", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "position", "description": "A number that indicates the order in which the attribute is displayed", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_id", "description": "This is the same as a product's id field", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "`product_id` is not needed and can be obtained from it's parent" }, { "name": "uid", "description": "The unique ID for a `ConfigurableProductOptions` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "use_default", "description": "Indicates whether the option is the default", "args": [], "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "values", "description": "An array that defines the value_index codes assigned to the configurable product", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "ConfigurableProductOptionsValues", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ConfigurableProductOptionsValues", "description": "ConfigurableProductOptionsValues contains the index number assigned to a configurable product option", "fields": [ { "name": "default_label", "description": "The label of the product on the default store", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "label", "description": "The label of the product", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "store_label", "description": "The label of the product on the current store", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "swatch_data", "description": "Swatch data for configurable product option", "args": [], "type": { "kind": "INTERFACE", "name": "SwatchDataInterface", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "uid", "description": "The unique ID for a `ConfigurableProductOptionsValues` object", "args": [], "type": { "kind": "SCALAR", "name": "ID", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "use_default_value", "description": "Indicates whether to use the default_label", "args": [], "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "value_index", "description": "A unique index number assigned to the configurable product option", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `uid` instead" } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "INTERFACE", "name": "SwatchDataInterface", "description": "", "fields": [ { "name": "value", "description": "Value of swatch item (HEX color code, image link or textual value)", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "ImageSwatchData", "ofType": null }, { "kind": "OBJECT", "name": "TextSwatchData", "ofType": null }, { "kind": "OBJECT", "name": "ColorSwatchData", "ofType": null } ] }, { "kind": "OBJECT", "name": "ConfigurableProductOptionsSelection", "description": "Metadata corresponding to the configurable options selection.", "fields": [ { "name": "media_gallery", "description": "Product images and videos corresponding to the specified configurable options selection.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "MediaGalleryInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "options_available_for_selection", "description": "Configurable options available for further selection based on current selection.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "ConfigurableOptionAvailableForSelection", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "variant", "description": "Variant represented by the specified configurable options selection. It is expected to be null, until selections are made for each configurable option.", "args": [], "type": { "kind": "OBJECT", "name": "SimpleProduct", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ConfigurableOptionAvailableForSelection", "description": "Configurable option available for further selection based on current selection.", "fields": [ { "name": "attribute_code", "description": "Attribute code that uniquely identifies configurable option.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "option_value_uids", "description": "Configurable option values available for further selection.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ConfigurableVariant", "description": "An array containing all the simple product variants of a configurable product", "fields": [ { "name": "attributes", "description": null, "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "ConfigurableAttributeOption", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product", "description": null, "args": [], "type": { "kind": "OBJECT", "name": "SimpleProduct", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ConfigurableAttributeOption", "description": "ConfigurableAttributeOption contains the value_index (and other related information) assigned to a configurable product option", "fields": [ { "name": "code", "description": "The ID assigned to the attribute", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "label", "description": "A string that describes the configurable attribute option", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "uid", "description": "The unique ID for a `ConfigurableAttributeOption` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "value_index", "description": "A unique index number assigned to the configurable product option", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ConfigurableWishlistItem", "description": "A configurable product wish list item", "fields": [ { "name": "added_at", "description": "The date and time the item was added to the wish list", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "child_sku", "description": "The SKU of the simple product corresponding to a set of selected configurable options", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "configurable_options", "description": "An array of selected configurable options", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "SelectedConfigurableOption", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customizable_options", "description": "Custom options selected for the wish list item", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "SelectedCustomizableOption", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": "The description of the item", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The unique ID for a `WishlistItemInterface` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product", "description": "Product details of the wish list item", "args": [], "type": { "kind": "INTERFACE", "name": "ProductInterface", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity", "description": "The quantity of this wish list item", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "WishlistItemInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "INTERFACE", "name": "SwatchLayerFilterItemInterface", "description": "", "fields": [ { "name": "swatch_data", "description": "Data required to render swatch filter item", "args": [], "type": { "kind": "OBJECT", "name": "SwatchData", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": null, "enumValues": null, "possibleTypes": [ { "kind": "OBJECT", "name": "SwatchLayerFilterItem", "ofType": null } ] }, { "kind": "OBJECT", "name": "SwatchData", "description": "", "fields": [ { "name": "type", "description": "Type of swatch filter item: 1 - text, 2 - image", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "Value for swatch item (text or image link)", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "SwatchLayerFilterItem", "description": "", "fields": [ { "name": "items_count", "description": "Count of items by filter.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use AggregationOption.count instead." }, { "name": "label", "description": "Filter label.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use AggregationOption.label instead." }, { "name": "swatch_data", "description": "Data required to render swatch filter item", "args": [], "type": { "kind": "OBJECT", "name": "SwatchData", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "value_string", "description": "Value for filter request variable to be used in query.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use AggregationOption.value instead." } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "LayerFilterItemInterface", "ofType": null }, { "kind": "INTERFACE", "name": "SwatchLayerFilterItemInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ImageSwatchData", "description": "", "fields": [ { "name": "thumbnail", "description": "Thumbnail swatch image URL", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "Value of swatch item (HEX color code, image link or textual value)", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "SwatchDataInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "TextSwatchData", "description": "", "fields": [ { "name": "value", "description": "Value of swatch item (HEX color code, image link or textual value)", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "SwatchDataInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "ColorSwatchData", "description": "", "fields": [ { "name": "value", "description": "Value of swatch item (HEX color code, image link or textual value)", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "SwatchDataInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "GiftCardProduct", "description": "GiftCardProduct defines properties of a gift card, including the minimum and maximum values and an array that contains the current and past values on the specific gift card", "fields": [ { "name": "allow_message", "description": "Indicates whether the customer can provide a message to accompany the gift card.", "args": [], "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "allow_open_amount", "description": "Indicates whether customers have the ability to set the value of the gift card.", "args": [], "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "attribute_set_id", "description": "The attribute set assigned to the product.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "canonical_url", "description": "Relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "categories", "description": "The categories assigned to a product.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "CategoryInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "color", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "country_of_manufacture", "description": "The product's country of origin.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "created_at", "description": "Timestamp indicating when the product was created.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "crosssell_products", "description": "Crosssell Products", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "ProductInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": "Detailed information about the product. The value can include simple HTML tags.", "args": [], "type": { "kind": "OBJECT", "name": "ComplexTextValue", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fashion_color", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fashion_material", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fashion_size", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "fashion_style", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "format", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "gift_card_options", "description": "An array of giftcard options.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "CustomizableOptionInterface", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "gift_message_available", "description": "Indicates whether a gift message is available.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "giftcard_amounts", "description": "An array that contains information about the values and ID of a gift card.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "GiftCardAmounts", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "giftcard_type", "description": "Either VIRTUAL, PHYSICAL, or COMBINED.", "args": [], "type": { "kind": "ENUM", "name": "GiftCardTypeEnum", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "has_video", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The ID number assigned to the product.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use the `uid` field instead." }, { "name": "image", "description": "The relative path to the main image on the product page.", "args": [], "type": { "kind": "OBJECT", "name": "ProductImage", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "is_redeemable", "description": "Indicates whether the customer can redeem the value on the card for cash.", "args": [], "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "is_returnable", "description": "Indicates whether the product can be returned", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "lifetime", "description": "The number of days after purchase until the gift card expires. A null value means there is no limit.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "manufacturer", "description": "A number representing the product's manufacturer.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "media_gallery", "description": "An array of Media Gallery objects.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "MediaGalleryInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "media_gallery_entries", "description": "An array of MediaGalleryEntry objects.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "MediaGalleryEntry", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use product's `media_gallery` instead" }, { "name": "message_max_length", "description": "Indicates whether the customer can provide a message to accompany the gift card.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "meta_description", "description": "A brief overview of the product for search results listings, maximum 255 characters.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "meta_keyword", "description": "A comma-separated list of keywords that are visible only to search engines.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "meta_title", "description": "A string that is displayed in the title bar and tab of the browser and in search results lists.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "name", "description": "The product name. Customers use this name to identify the product.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "new_from_date", "description": "The beginning date for new product listings, and determines if the product is featured as a new product.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "new_to_date", "description": "The end date for new product listings.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "only_x_left_in_stock", "description": "Product stock only x left count", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "open_amount_max", "description": "The minimum acceptable value of an open amount gift card.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "open_amount_min", "description": "The minimum acceptable value of an open amount gift card.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "options", "description": "An array of options for a customizable product.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "CustomizableOptionInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "options_container", "description": "If the product has multiple options, determines where they appear on the product page.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "price", "description": "A ProductPrices object, indicating the price of an item.", "args": [], "type": { "kind": "OBJECT", "name": "ProductPrices", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use price_range for product price information." }, { "name": "price_range", "description": "A PriceRange object, indicating the range of prices for the product", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "PriceRange", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "price_tiers", "description": "An array of TierPrice objects.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "TierPrice", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_links", "description": "An array of ProductLinks objects.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "ProductLinksInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "rating_summary", "description": "The average of all the ratings given to the product.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "related_products", "description": "Related Products", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "ProductInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "review_count", "description": "The total count of all the reviews given to the product.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Int", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "reviews", "description": "The list of products reviews.", "args": [ { "name": "pageSize", "description": "Specifies the maximum number of results to return at once.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": "20" }, { "name": "currentPage", "description": "Specifies which page of results to return.", "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "defaultValue": "1" } ], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductReviews", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "short_description", "description": "A short description of the product. Its use depends on the theme.", "args": [], "type": { "kind": "OBJECT", "name": "ComplexTextValue", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sku", "description": "A number or code assigned to a product to identify the product, options, price, and manufacturer.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "small_image", "description": "The relative path to the small image, which is used on catalog pages.", "args": [], "type": { "kind": "OBJECT", "name": "ProductImage", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "special_from_date", "description": "The beginning date that a product has a special price.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "special_price", "description": "The discounted price of the product.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "special_to_date", "description": "The end date that a product has a special price.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "staged", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "stock_status", "description": "Stock status of the product", "args": [], "type": { "kind": "ENUM", "name": "ProductStockStatus", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "swatch_image", "description": "The file name of a swatch image", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "thumbnail", "description": "The relative path to the product's thumbnail image.", "args": [], "type": { "kind": "OBJECT", "name": "ProductImage", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "tier_price", "description": "The price when tier pricing is in effect and the items purchased threshold has been reached.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use price_tiers for product tier price information." }, { "name": "tier_prices", "description": "An array of ProductTierPrices objects.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "ProductTierPrices", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use price_tiers for product tier price information." }, { "name": "type_id", "description": "One of simple, virtual, bundle, downloadable, grouped, or configurable.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use __typename instead." }, { "name": "uid", "description": "The unique ID for a `ProductInterface` object.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "updated_at", "description": "Timestamp indicating when the product was updated.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "upsell_products", "description": "Upsell Products", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "INTERFACE", "name": "ProductInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "url_key", "description": "The part of the URL that identifies the product", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "url_path", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use product's `canonical_url` or url rewrites instead" }, { "name": "url_rewrites", "description": "URL rewrites list", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "UrlRewrite", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "url_suffix", "description": "The part of the product URL that is appended after the url key", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "video_file", "description": null, "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "websites", "description": "An array of websites in which the product is available.", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "Website", "ofType": null } }, "isDeprecated": true, "deprecationReason": "The field should not be used on the storefront." }, { "name": "weight", "description": "The weight of the item, in units defined by the store.", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "ProductInterface", "ofType": null }, { "kind": "INTERFACE", "name": "PhysicalProductInterface", "ofType": null }, { "kind": "INTERFACE", "name": "CustomizableProductInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "GiftCardAmounts", "description": "GiftCardAmounts contains the value of a gift card, the website that generated the card, and related information", "fields": [ { "name": "attribute_id", "description": "An internal attribute ID.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "uid", "description": "The unique ID for a `GiftCardAmounts` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "value", "description": "The value of the gift card", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "value_id", "description": "An ID that is assigned to each unique gift card amount.", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": true, "deprecationReason": "Use `uid` instead" }, { "name": "website_id", "description": "ID of the website that generated the gift card", "args": [], "type": { "kind": "SCALAR", "name": "Int", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "website_value", "description": "The value of the gift card", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "ENUM", "name": "GiftCardTypeEnum", "description": "This enumeration defines the types of gift cards", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "VIRTUAL", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "PHYSICAL", "description": "", "isDeprecated": false, "deprecationReason": "" }, { "name": "COMBINED", "description": "", "isDeprecated": false, "deprecationReason": "" } ], "possibleTypes": null }, { "kind": "OBJECT", "name": "GiftCardOrderItem", "description": "", "fields": [ { "name": "discounts", "description": "The final discount information for the product", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "Discount", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "eligible_for_return", "description": "Indicates whether the order item is eligible is eligible to be in a return request", "args": [], "type": { "kind": "SCALAR", "name": "Boolean", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "entered_options", "description": "The entered option for the base product, such as a logo or image", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "OrderItemOption", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "gift_card", "description": "Selected gift card properties for an order item", "args": [], "type": { "kind": "OBJECT", "name": "GiftCardItem", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "gift_wrapping", "description": "The selected gift wrapping for the order item", "args": [], "type": { "kind": "OBJECT", "name": "GiftWrapping", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The unique ID for a `OrderItemInterface` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_name", "description": "The name of the base product", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_sale_price", "description": "The sale price of the base product, including selected options", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_sku", "description": "The SKU of the base product", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_type", "description": "The type of product, such as simple, configurable, etc.", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_url_key", "description": "URL key of the base product", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity_canceled", "description": "The number of canceled items", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity_invoiced", "description": "The number of invoiced items", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity_ordered", "description": "The number of units ordered for this item", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity_refunded", "description": "The number of refunded items", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity_returned", "description": "The number of returned items", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity_shipped", "description": "The number of shipped items", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "selected_options", "description": "The selected options for the base product, such as color or size", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "OrderItemOption", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "status", "description": "The status of the order item", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "OrderItemInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "GiftCardItem", "description": "", "fields": [ { "name": "message", "description": "Entered gift card message intended for the recipient", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "recipient_email", "description": "Entered gift card recipient email for virtual cards", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "recipient_name", "description": "Entered gift card sender namefor physical and virtual cards", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sender_email", "description": "Entered gift card sender email for virtual cards", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sender_name", "description": "Entered gift card sender name for physical and virtual cards", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "GiftCardInvoiceItem", "description": "", "fields": [ { "name": "discounts", "description": "Contains information about the final discount amount for the base product, including discounts on options", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "Discount", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "gift_card", "description": "Selected gift card properties for an invoice item", "args": [], "type": { "kind": "OBJECT", "name": "GiftCardItem", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The unique ID for a `InvoiceItemInterface` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "order_item", "description": "Contains details about an individual order item", "args": [], "type": { "kind": "INTERFACE", "name": "OrderItemInterface", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_name", "description": "The name of the base product", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_sale_price", "description": "The sale price for the base product including selected options", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_sku", "description": "The SKU of the base product", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity_invoiced", "description": "The number of invoiced items", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "InvoiceItemInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "GiftCardCreditMemoItem", "description": "", "fields": [ { "name": "discounts", "description": "Contains information about the final discount amount for the base product, including discounts on options", "args": [], "type": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "Discount", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "gift_card", "description": "Selected gift card properties for an credit memo item", "args": [], "type": { "kind": "OBJECT", "name": "GiftCardItem", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The unique ID for a `CreditMemoItemInterface` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "order_item", "description": "The order item the credit memo is applied to", "args": [], "type": { "kind": "INTERFACE", "name": "OrderItemInterface", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_name", "description": "The name of the base product", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_sale_price", "description": "The sale price for the base product, including selected options", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_sku", "description": "SKU of the base product", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity_refunded", "description": "The number of refunded items", "args": [], "type": { "kind": "SCALAR", "name": "Float", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "CreditMemoItemInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "GiftCardShipmentItem", "description": "", "fields": [ { "name": "gift_card", "description": "Selected gift card properties for an shipment item", "args": [], "type": { "kind": "OBJECT", "name": "GiftCardItem", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The unique ID for a `ShipmentItemInterface` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "order_item", "description": "Associated order item", "args": [], "type": { "kind": "INTERFACE", "name": "OrderItemInterface", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_name", "description": "Name of the base product", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_sale_price", "description": "Sale price for the base product", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product_sku", "description": "SKU of the base product", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity_shipped", "description": "Number of shipped items", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "ShipmentItemInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "GiftCardCartItem", "description": "Contains details about a gift card", "fields": [ { "name": "amount", "description": "The amount and currency of the gift card", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "Money", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customizable_options", "description": "An array of customizations made to the gift card", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "SelectedCustomizableOption", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": true, "deprecationReason": "Use `uid` instead" }, { "name": "message", "description": "A message to the recipient", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "prices", "description": null, "args": [], "type": { "kind": "OBJECT", "name": "CartItemPrices", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "product", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "INTERFACE", "name": "ProductInterface", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "recipient_email", "description": "The email of the person receiving the gift card", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "recipient_name", "description": "The name of the person receiving the gift card", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "sender_email", "description": "The email of the sender", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sender_name", "description": "The name of the sender", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "uid", "description": "The unique ID for a `CartItemInterface` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "CartItemInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "GiftCardWishlistItem", "description": "A gift card product wish list item", "fields": [ { "name": "added_at", "description": "The date and time the item was added to the wish list", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "String", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "customizable_options", "description": "Custom options selected for the wish list item", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "LIST", "name": null, "ofType": { "kind": "OBJECT", "name": "SelectedCustomizableOption", "ofType": null } } }, "isDeprecated": false, "deprecationReason": null }, { "name": "description", "description": "The description of the item", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "gift_card_options", "description": null, "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "OBJECT", "name": "GiftCardOptions", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "id", "description": "The unique ID for a `WishlistItemInterface` object", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "ID", "ofType": null } }, "isDeprecated": false, "deprecationReason": null }, { "name": "product", "description": "Product details of the wish list item", "args": [], "type": { "kind": "INTERFACE", "name": "ProductInterface", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "quantity", "description": "The quantity of this wish list item", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Float", "ofType": null } }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [ { "kind": "INTERFACE", "name": "WishlistItemInterface", "ofType": null } ], "enumValues": null, "possibleTypes": null }, { "kind": "OBJECT", "name": "GiftCardOptions", "description": "", "fields": [ { "name": "amount", "description": "The amount and currency of the gift card", "args": [], "type": { "kind": "OBJECT", "name": "Money", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "custom_giftcard_amount", "description": "The custom amount and currency of the gift card", "args": [], "type": { "kind": "OBJECT", "name": "Money", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "message", "description": "A message to the recipient", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "recipient_email", "description": "The email of the person receiving the gift card", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "recipient_name", "description": "The name of the person receiving the gift card", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sender_email", "description": "The email of the sender", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null }, { "name": "sender_name", "description": "The name of the sender", "args": [], "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "isDeprecated": false, "deprecationReason": null } ], "inputFields": null, "interfaces": [], "enumValues": null, "possibleTypes": null } ], "directives": [ { "name": "include", "description": "Directs the executor to include this field or fragment only when the `if` argument is true.", "locations": [ "FIELD", "FRAGMENT_SPREAD", "INLINE_FRAGMENT" ], "args": [ { "name": "if", "description": "Included when true.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "defaultValue": null } ] }, { "name": "skip", "description": "Directs the executor to skip this field or fragment when the `if` argument is true.", "locations": [ "FIELD", "FRAGMENT_SPREAD", "INLINE_FRAGMENT" ], "args": [ { "name": "if", "description": "Skipped when true.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", "name": "Boolean", "ofType": null } }, "defaultValue": null } ] }, { "name": "deprecated", "description": "Marks an element of a GraphQL schema as no longer supported.", "locations": [ "FIELD_DEFINITION", "ENUM_VALUE" ], "args": [ { "name": "reason", "description": "Explains why this element was deprecated, usually also including a suggestion for how to access supported similar data. Formatted in [Markdown](https://daringfireball.net/projects/markdown/).", "type": { "kind": "SCALAR", "name": "String", "ofType": null }, "defaultValue": "\"No longer supported\"" } ] } ] } }, "extensions": { "graphql-config": { "source": "https://master-7rqtwti-c5v7sxvquxwl4.eu-4.magentosite.cloud//graphql", "timestamp": "Tue Jan 12 2021 22:12:22 GMT+0700 (Indochina Time)" } } }