Adobe Commerce GraphQL API (2.4.9-beta-1)
+Adobe Commerce GraphQL API (2.4.8)
API Endpoints
Version
-2.4.9-beta-1
+2.4.8
Query
braintree_paypal_vault_active cart_expires_in_days cart_gift_wrapping - cart_merge_preference cart_printed_card cart_summary_display_quantity catalog_default_sort_by @@ -1486,6 +1471,7 @@Query
fixed_product_taxes_enable fixed_product_taxes_include_fpt_in_subtotal front + graphql_share_all_customer_groups graphql_share_customer_group grid_per_page grid_per_page_values @@ -1563,8 +1549,10 @@Query
send_friend { ...SendFriendConfigurationFragment } - share_active_segments - share_applied_cart_rule + share_all_catalog_rules + share_all_sales_rule + share_applied_catalog_rules + share_applied_sales_rule shopping_cart_display_full_summary shopping_cart_display_grand_total shopping_cart_display_price @@ -1611,25 +1599,25 @@Response
"availableStores": [ { "absolute_footer": "xyz789", - "allow_gift_receipt": "abc123", - "allow_gift_wrapping_on_order": "xyz789", - "allow_gift_wrapping_on_order_items": "abc123", + "allow_gift_receipt": "xyz789", + "allow_gift_wrapping_on_order": "abc123", + "allow_gift_wrapping_on_order_items": "xyz789", "allow_guests_to_write_product_reviews": "xyz789", - "allow_items": "xyz789", + "allow_items": "abc123", "allow_order": "abc123", "allow_printed_card": "xyz789", - "autocomplete_on_storefront": false, + "autocomplete_on_storefront": true, "base_currency_code": "xyz789", "base_link_url": "xyz789", "base_media_url": "abc123", "base_static_url": "abc123", - "base_url": "xyz789", + "base_url": "abc123", "braintree_3dsecure_allowspecific": true, "braintree_3dsecure_always_request_3ds": false, "braintree_3dsecure_specificcountry": "abc123", "braintree_3dsecure_threshold_amount": "xyz789", - "braintree_3dsecure_verify_3dsecure": false, - "braintree_ach_direct_debit_vault_active": false, + "braintree_3dsecure_verify_3dsecure": true, + "braintree_ach_direct_debit_vault_active": true, "braintree_applepay_merchant_name": "abc123", "braintree_applepay_vault_active": false, "braintree_cc_vault_active": "abc123", @@ -1638,158 +1626,158 @@Response
"braintree_googlepay_btn_color": "abc123", "braintree_googlepay_cctypes": "xyz789", "braintree_googlepay_merchant_id": "abc123", - "braintree_googlepay_vault_active": true, - "braintree_local_payment_allowed_methods": "abc123", - "braintree_local_payment_fallback_button_text": "abc123", - "braintree_local_payment_redirect_on_fail": "abc123", + "braintree_googlepay_vault_active": false, + "braintree_local_payment_allowed_methods": "xyz789", + "braintree_local_payment_fallback_button_text": "xyz789", + "braintree_local_payment_redirect_on_fail": "xyz789", "braintree_merchant_account_id": "xyz789", "braintree_paypal_button_location_cart_type_credit_color": "xyz789", - "braintree_paypal_button_location_cart_type_credit_label": "abc123", - "braintree_paypal_button_location_cart_type_credit_shape": "xyz789", + "braintree_paypal_button_location_cart_type_credit_label": "xyz789", + "braintree_paypal_button_location_cart_type_credit_shape": "abc123", "braintree_paypal_button_location_cart_type_credit_show": true, - "braintree_paypal_button_location_cart_type_messaging_layout": "xyz789", - "braintree_paypal_button_location_cart_type_messaging_logo": "xyz789", + "braintree_paypal_button_location_cart_type_messaging_layout": "abc123", + "braintree_paypal_button_location_cart_type_messaging_logo": "abc123", "braintree_paypal_button_location_cart_type_messaging_logo_position": "abc123", - "braintree_paypal_button_location_cart_type_messaging_show": true, + "braintree_paypal_button_location_cart_type_messaging_show": false, "braintree_paypal_button_location_cart_type_messaging_text_color": "abc123", - "braintree_paypal_button_location_cart_type_paylater_color": "abc123", - "braintree_paypal_button_location_cart_type_paylater_label": "xyz789", - "braintree_paypal_button_location_cart_type_paylater_shape": "abc123", + "braintree_paypal_button_location_cart_type_paylater_color": "xyz789", + "braintree_paypal_button_location_cart_type_paylater_label": "abc123", + "braintree_paypal_button_location_cart_type_paylater_shape": "xyz789", "braintree_paypal_button_location_cart_type_paylater_show": true, - "braintree_paypal_button_location_cart_type_paypal_color": "xyz789", - "braintree_paypal_button_location_cart_type_paypal_label": "xyz789", + "braintree_paypal_button_location_cart_type_paypal_color": "abc123", + "braintree_paypal_button_location_cart_type_paypal_label": "abc123", "braintree_paypal_button_location_cart_type_paypal_shape": "abc123", - "braintree_paypal_button_location_cart_type_paypal_show": false, + "braintree_paypal_button_location_cart_type_paypal_show": true, "braintree_paypal_button_location_checkout_type_credit_color": "xyz789", - "braintree_paypal_button_location_checkout_type_credit_label": "abc123", + "braintree_paypal_button_location_checkout_type_credit_label": "xyz789", "braintree_paypal_button_location_checkout_type_credit_shape": "abc123", "braintree_paypal_button_location_checkout_type_credit_show": false, "braintree_paypal_button_location_checkout_type_messaging_layout": "abc123", "braintree_paypal_button_location_checkout_type_messaging_logo": "xyz789", - "braintree_paypal_button_location_checkout_type_messaging_logo_position": "xyz789", + "braintree_paypal_button_location_checkout_type_messaging_logo_position": "abc123", "braintree_paypal_button_location_checkout_type_messaging_show": false, - "braintree_paypal_button_location_checkout_type_messaging_text_color": "abc123", - "braintree_paypal_button_location_checkout_type_paylater_color": "xyz789", + "braintree_paypal_button_location_checkout_type_messaging_text_color": "xyz789", + "braintree_paypal_button_location_checkout_type_paylater_color": "abc123", "braintree_paypal_button_location_checkout_type_paylater_label": "abc123", "braintree_paypal_button_location_checkout_type_paylater_shape": "xyz789", "braintree_paypal_button_location_checkout_type_paylater_show": false, "braintree_paypal_button_location_checkout_type_paypal_color": "abc123", "braintree_paypal_button_location_checkout_type_paypal_label": "xyz789", "braintree_paypal_button_location_checkout_type_paypal_shape": "xyz789", - "braintree_paypal_button_location_checkout_type_paypal_show": true, - "braintree_paypal_button_location_productpage_type_credit_color": "abc123", + "braintree_paypal_button_location_checkout_type_paypal_show": false, + "braintree_paypal_button_location_productpage_type_credit_color": "xyz789", "braintree_paypal_button_location_productpage_type_credit_label": "xyz789", "braintree_paypal_button_location_productpage_type_credit_shape": "abc123", "braintree_paypal_button_location_productpage_type_credit_show": true, "braintree_paypal_button_location_productpage_type_messaging_layout": "xyz789", - "braintree_paypal_button_location_productpage_type_messaging_logo": "xyz789", - "braintree_paypal_button_location_productpage_type_messaging_logo_position": "xyz789", + "braintree_paypal_button_location_productpage_type_messaging_logo": "abc123", + "braintree_paypal_button_location_productpage_type_messaging_logo_position": "abc123", "braintree_paypal_button_location_productpage_type_messaging_show": false, - "braintree_paypal_button_location_productpage_type_messaging_text_color": "xyz789", - "braintree_paypal_button_location_productpage_type_paylater_color": "xyz789", + "braintree_paypal_button_location_productpage_type_messaging_text_color": "abc123", + "braintree_paypal_button_location_productpage_type_paylater_color": "abc123", "braintree_paypal_button_location_productpage_type_paylater_label": "xyz789", - "braintree_paypal_button_location_productpage_type_paylater_shape": "xyz789", - "braintree_paypal_button_location_productpage_type_paylater_show": false, + "braintree_paypal_button_location_productpage_type_paylater_shape": "abc123", + "braintree_paypal_button_location_productpage_type_paylater_show": true, "braintree_paypal_button_location_productpage_type_paypal_color": "abc123", "braintree_paypal_button_location_productpage_type_paypal_label": "abc123", "braintree_paypal_button_location_productpage_type_paypal_shape": "abc123", - "braintree_paypal_button_location_productpage_type_paypal_show": true, + "braintree_paypal_button_location_productpage_type_paypal_show": false, "braintree_paypal_credit_uk_merchant_name": "abc123", "braintree_paypal_display_on_shopping_cart": false, "braintree_paypal_merchant_country": "xyz789", - "braintree_paypal_merchant_name_override": "xyz789", - "braintree_paypal_require_billing_address": true, + "braintree_paypal_merchant_name_override": "abc123", + "braintree_paypal_require_billing_address": false, "braintree_paypal_send_cart_line_items": false, - "braintree_paypal_vault_active": true, - "cart_expires_in_days": 987, - "cart_gift_wrapping": "abc123", - "cart_merge_preference": "xyz789", - "cart_printed_card": "abc123", + "braintree_paypal_vault_active": false, + "cart_expires_in_days": 123, + "cart_gift_wrapping": "xyz789", + "cart_printed_card": "xyz789", "cart_summary_display_quantity": 987, - "catalog_default_sort_by": "abc123", + "catalog_default_sort_by": "xyz789", "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", "category_url_suffix": "abc123", "check_money_order_enable_for_specific_countries": false, - "check_money_order_enabled": true, + "check_money_order_enabled": false, "check_money_order_make_check_payable_to": "xyz789", "check_money_order_max_order_total": "abc123", "check_money_order_min_order_total": "abc123", "check_money_order_new_order_status": "abc123", - "check_money_order_payment_from_specific_countries": "abc123", - "check_money_order_send_check_to": "xyz789", - "check_money_order_sort_order": 123, - "check_money_order_title": "abc123", - "cms_home_page": "abc123", + "check_money_order_payment_from_specific_countries": "xyz789", + "check_money_order_send_check_to": "abc123", + "check_money_order_sort_order": 987, + "check_money_order_title": "xyz789", + "cms_home_page": "xyz789", "cms_no_cookies": "xyz789", - "cms_no_route": "abc123", + "cms_no_route": "xyz789", "code": "abc123", "configurable_product_image": "ITSELF", - "configurable_thumbnail_source": "abc123", + "configurable_thumbnail_source": "xyz789", "contact_enabled": true, - "copyright": "abc123", - "countries_with_required_region": "xyz789", - "create_account_confirmation": false, + "copyright": "xyz789", + "countries_with_required_region": "abc123", + "create_account_confirmation": true, "customer_access_token_lifetime": 123.45, - "default_country": "xyz789", + "default_country": "abc123", "default_description": "xyz789", "default_display_currency_code": "abc123", "default_keywords": "xyz789", "default_title": "xyz789", "demonotice": 123, - "display_product_prices_in_catalog": 987, + "display_product_prices_in_catalog": 123, "display_shipping_prices": 987, "display_state_if_optional": false, - "enable_multiple_wishlists": "xyz789", - "fixed_product_taxes_apply_tax_to_fpt": true, - "fixed_product_taxes_display_prices_in_emails": 987, - "fixed_product_taxes_display_prices_in_product_lists": 123, - "fixed_product_taxes_display_prices_in_sales_modules": 123, + "enable_multiple_wishlists": "abc123", + "fixed_product_taxes_apply_tax_to_fpt": false, + "fixed_product_taxes_display_prices_in_emails": 123, + "fixed_product_taxes_display_prices_in_product_lists": 987, + "fixed_product_taxes_display_prices_in_sales_modules": 987, "fixed_product_taxes_display_prices_on_product_view_page": 123, "fixed_product_taxes_enable": true, "fixed_product_taxes_include_fpt_in_subtotal": true, "front": "xyz789", - "graphql_share_customer_group": false, + "graphql_share_all_customer_groups": false, + "graphql_share_customer_group": true, "grid_per_page": 987, - "grid_per_page_values": "abc123", + "grid_per_page_values": "xyz789", "grouped_product_image": "ITSELF", - "head_includes": "xyz789", - "head_shortcut_icon": "abc123", + "head_includes": "abc123", + "head_shortcut_icon": "xyz789", "header_logo_src": "abc123", "id": 987, - "is_checkout_agreements_enabled": false, - "is_default_store": false, - "is_default_store_group": false, + "is_checkout_agreements_enabled": true, + "is_default_store": true, + "is_default_store_group": true, "is_guest_checkout_enabled": true, - "is_negotiable_quote_active": false, + "is_negotiable_quote_active": true, "is_one_page_checkout_enabled": true, - "is_requisition_list_active": "xyz789", + "is_requisition_list_active": "abc123", "list_mode": "abc123", - "list_per_page": 987, + "list_per_page": 123, "list_per_page_values": "abc123", - "locale": "abc123", - "logo_alt": "xyz789", - "logo_height": 123, + "locale": "xyz789", + "logo_alt": "abc123", + "logo_height": 987, "logo_width": 123, - "magento_reward_general_is_enabled": "abc123", + "magento_reward_general_is_enabled": "xyz789", "magento_reward_general_is_enabled_on_front": "xyz789", "magento_reward_general_min_points_balance": "abc123", "magento_reward_general_publish_history": "abc123", "magento_reward_points_invitation_customer": "xyz789", "magento_reward_points_invitation_customer_limit": "abc123", "magento_reward_points_invitation_order": "xyz789", - "magento_reward_points_invitation_order_limit": "xyz789", + "magento_reward_points_invitation_order_limit": "abc123", "magento_reward_points_newsletter": "xyz789", "magento_reward_points_order": "xyz789", - "magento_reward_points_register": "abc123", + "magento_reward_points_register": "xyz789", "magento_reward_points_review": "xyz789", "magento_reward_points_review_limit": "xyz789", "magento_wishlist_general_is_enabled": "abc123", "max_items_in_order_summary": 987, "maximum_number_of_wishlists": "abc123", "minicart_display": false, - "minicart_max_items": 987, - "minimum_password_length": "abc123", - "newsletter_enabled": false, + "minicart_max_items": 123, + "minimum_password_length": "xyz789", + "newsletter_enabled": true, "no_route": "abc123", "optional_zip_countries": "abc123", "order_cancellation_enabled": false, @@ -1797,20 +1785,20 @@Response
CancellationReason ], "orders_invoices_credit_memos_display_full_summary": false, - "orders_invoices_credit_memos_display_grandtotal": false, + "orders_invoices_credit_memos_display_grandtotal": true, "orders_invoices_credit_memos_display_price": 987, - "orders_invoices_credit_memos_display_shipping_amount": 987, - "orders_invoices_credit_memos_display_subtotal": 987, - "orders_invoices_credit_memos_display_zero_tax": false, + "orders_invoices_credit_memos_display_shipping_amount": 123, + "orders_invoices_credit_memos_display_subtotal": 123, + "orders_invoices_credit_memos_display_zero_tax": true, "payment_payflowpro_cc_vault_active": "abc123", - "printed_card_price": "xyz789", + "printed_card_price": "abc123", "printed_card_priceV2": Money, "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", "product_reviews_enabled": "xyz789", "product_url_suffix": "xyz789", - "quickorder_active": true, + "quickorder_active": false, "required_character_classes_number": "xyz789", - "returns_enabled": "xyz789", + "returns_enabled": "abc123", "root_category_id": 987, "root_category_uid": "4", "sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", @@ -1818,40 +1806,42 @@Response
"sales_printed_card": "abc123", "secure_base_link_url": "abc123", "secure_base_media_url": "abc123", - "secure_base_static_url": "xyz789", + "secure_base_static_url": "abc123", "secure_base_url": "abc123", "send_friend": SendFriendConfiguration, - "share_active_segments": true, - "share_applied_cart_rule": false, - "shopping_cart_display_full_summary": false, + "share_all_catalog_rules": false, + "share_all_sales_rule": true, + "share_applied_catalog_rules": false, + "share_applied_sales_rule": false, + "shopping_cart_display_full_summary": true, "shopping_cart_display_grand_total": true, - "shopping_cart_display_price": 987, - "shopping_cart_display_shipping": 987, + "shopping_cart_display_price": 123, + "shopping_cart_display_shipping": 123, "shopping_cart_display_subtotal": 987, "shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX", "shopping_cart_display_zero_tax": false, "show_cms_breadcrumbs": 123, "store_code": 4, - "store_group_code": "4", + "store_group_code": 4, "store_group_name": "xyz789", - "store_name": "xyz789", - "store_sort_order": 987, + "store_name": "abc123", + "store_sort_order": 123, "timezone": "abc123", - "title_prefix": "xyz789", + "title_prefix": "abc123", "title_separator": "xyz789", "title_suffix": "abc123", - "use_store_in_url": false, - "website_code": "4", - "website_id": 987, - "website_name": "xyz789", - "weight_unit": "xyz789", + "use_store_in_url": true, + "website_code": 4, + "website_id": 123, + "website_name": "abc123", + "weight_unit": "abc123", "welcome": "xyz789", "zero_subtotal_enable_for_specific_countries": true, - "zero_subtotal_enabled": true, + "zero_subtotal_enabled": false, "zero_subtotal_new_order_status": "xyz789", - "zero_subtotal_payment_action": "abc123", + "zero_subtotal_payment_action": "xyz789", "zero_subtotal_payment_from_specific_countries": "xyz789", - "zero_subtotal_sort_order": 123, + "zero_subtotal_sort_order": 987, "zero_subtotal_title": "abc123" } ] @@ -1955,7 +1945,7 @@Query
} printed_card_included rules { - ...CartRuleStorefrontFragment + ...CartRuleFragment } selected_payment_method { ...SelectedPaymentMethodFragment @@ -1970,7 +1960,7 @@Query
Variables
-{"cart_id": "abc123"}
+ {"cart_id": "xyz789"}
Response
AvailablePaymentMethod ], "billing_address": BillingCartAddress, - "email": "abc123", + "email": "xyz789", "gift_message": GiftMessage, "gift_receipt_included": true, "gift_wrapping": GiftWrapping, "id": "4", - "is_virtual": false, + "is_virtual": true, "items": [CartItemInterface], "itemsV2": CartItems, "prices": CartPrices, "printed_card_included": true, - "rules": [CartRuleStorefront], + "rules": [CartRule], "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], - "total_quantity": 123.45 + "total_quantity": 987.65 } } } @@ -2228,41 +2218,41 @@Response
{
"data": {
"category": {
- "automatic_sorting": "xyz789",
+ "automatic_sorting": "abc123",
"available_sort_by": ["abc123"],
"breadcrumbs": [Breadcrumb],
"canonical_url": "abc123",
"children": [CategoryTree],
- "children_count": "abc123",
+ "children_count": "xyz789",
"cms_block": CmsBlock,
"created_at": "abc123",
"custom_layout_update_file": "abc123",
- "default_sort_by": "xyz789",
- "description": "abc123",
+ "default_sort_by": "abc123",
+ "description": "xyz789",
"display_mode": "xyz789",
"filter_price_range": 987.65,
"id": 987,
- "image": "abc123",
+ "image": "xyz789",
"include_in_menu": 123,
"is_anchor": 987,
"landing_page": 987,
- "level": 123,
- "meta_description": "xyz789",
- "meta_keywords": "xyz789",
- "meta_title": "xyz789",
+ "level": 987,
+ "meta_description": "abc123",
+ "meta_keywords": "abc123",
+ "meta_title": "abc123",
"name": "abc123",
- "path": "abc123",
+ "path": "xyz789",
"path_in_store": "xyz789",
"position": 987,
- "product_count": 987,
+ "product_count": 123,
"products": CategoryProducts,
- "redirect_code": 123,
+ "redirect_code": 987,
"relative_url": "xyz789",
- "staged": false,
+ "staged": true,
"type": "CMS_PAGE",
"uid": "4",
"updated_at": "xyz789",
- "url_key": "xyz789",
+ "url_key": "abc123",
"url_path": "abc123",
"url_suffix": "abc123"
}
@@ -2417,38 +2407,38 @@ Response
"breadcrumbs": [Breadcrumb],
"canonical_url": "abc123",
"children": [CategoryTree],
- "children_count": "xyz789",
+ "children_count": "abc123",
"cms_block": CmsBlock,
"created_at": "abc123",
- "custom_layout_update_file": "abc123",
+ "custom_layout_update_file": "xyz789",
"default_sort_by": "abc123",
"description": "xyz789",
- "display_mode": "abc123",
- "filter_price_range": 987.65,
- "id": 987,
- "image": "xyz789",
+ "display_mode": "xyz789",
+ "filter_price_range": 123.45,
+ "id": 123,
+ "image": "abc123",
"include_in_menu": 987,
- "is_anchor": 123,
- "landing_page": 987,
+ "is_anchor": 987,
+ "landing_page": 123,
"level": 987,
"meta_description": "abc123",
"meta_keywords": "abc123",
"meta_title": "abc123",
- "name": "abc123",
+ "name": "xyz789",
"path": "xyz789",
- "path_in_store": "xyz789",
+ "path_in_store": "abc123",
"position": 123,
- "product_count": 123,
+ "product_count": 987,
"products": CategoryProducts,
"redirect_code": 123,
- "relative_url": "abc123",
- "staged": true,
+ "relative_url": "xyz789",
+ "staged": false,
"type": "CMS_PAGE",
- "uid": "4",
+ "uid": 4,
"updated_at": "xyz789",
"url_key": "abc123",
- "url_path": "abc123",
- "url_suffix": "abc123"
+ "url_path": "xyz789",
+ "url_suffix": "xyz789"
}
]
}
@@ -2504,13 +2494,13 @@ Response
"data": {
"checkoutAgreements": [
{
- "agreement_id": 987,
+ "agreement_id": 123,
"checkbox_text": "xyz789",
"content": "abc123",
"content_height": "xyz789",
- "is_html": true,
+ "is_html": false,
"mode": "AUTO",
- "name": "xyz789"
+ "name": "abc123"
}
]
}
@@ -2666,7 +2656,7 @@ Query
Variables
-{"id": 123, "identifier": "xyz789"}
+ {"id": 987, "identifier": "xyz789"}
Response
"data": { "cmsPage": { "content": "abc123", - "content_heading": "abc123", - "identifier": "xyz789", - "meta_description": "xyz789", - "meta_keywords": "xyz789", - "meta_title": "abc123", + "content_heading": "xyz789", + "identifier": "abc123", + "meta_description": "abc123", + "meta_keywords": "abc123", + "meta_title": "xyz789", "page_layout": "xyz789", - "redirect_code": 987, + "redirect_code": 123, "relative_url": "abc123", "title": "abc123", "type": "CMS_PAGE", @@ -2780,12 +2770,12 @@Response
"credit": CompanyCredit, "credit_history": CompanyCreditHistory, "email": "xyz789", - "id": "4", + "id": 4, "legal_address": CompanyLegalAddress, "legal_name": "xyz789", - "name": "abc123", - "payment_methods": ["xyz789"], - "reseller_id": "abc123", + "name": "xyz789", + "payment_methods": ["abc123"], + "reseller_id": "xyz789", "role": CompanyRole, "roles": CompanyRoles, "sales_representative": CompanySalesRepresentative, @@ -2793,7 +2783,7 @@Response
"team": CompanyTeam, "user": Customer, "users": CompanyUsers, - "vat_tax_id": "abc123" + "vat_tax_id": "xyz789" } } } @@ -2864,7 +2854,7 @@Query
Variables
-{"uid": 4}
+ {"uid": "4"}
Response
"data": { "compareList": { "attributes": [ComparableAttribute], - "item_count": 987, + "item_count": 123, "items": [ComparableItem], - "uid": "4" + "uid": 4 } } } @@ -2934,8 +2924,8 @@Response
"available_regions": [Region], "full_name_english": "xyz789", "full_name_locale": "xyz789", - "id": "abc123", - "three_letter_abbreviation": "abc123", + "id": "xyz789", + "three_letter_abbreviation": "xyz789", "two_letter_abbreviation": "xyz789" } ] @@ -3009,7 +2999,7 @@Query
Variables
-{"id": "xyz789"}
+ {"id": "abc123"}
Response
"data": { "country": { "available_regions": [Region], - "full_name_english": "abc123", - "full_name_locale": "abc123", - "id": "xyz789", + "full_name_english": "xyz789", + "full_name_locale": "xyz789", + "id": "abc123", "three_letter_abbreviation": "xyz789", "two_letter_abbreviation": "xyz789" } @@ -3086,7 +3076,7 @@Response
"base_currency_symbol": "xyz789", "default_display_currecy_code": "xyz789", "default_display_currecy_symbol": "xyz789", - "default_display_currency_code": "xyz789", + "default_display_currency_code": "abc123", "default_display_currency_symbol": "abc123", "exchange_rates": [ExchangeRate] } @@ -3316,7 +3306,7 @@Query
...GiftRegistryFragment } group { - ...CustomerGroupStorefrontFragment + ...CustomerGroupFragment } group_id id @@ -3363,7 +3353,7 @@Query
...CompanyRoleFragment } segments { - ...CustomerSegmentStorefrontFragment + ...CustomerSegmentFragment } status store_credit { @@ -3396,30 +3386,30 @@Response
"customer": { "addresses": [CustomerAddress], "addressesV2": CustomerAddresses, - "allow_remote_shopping_assistance": true, + "allow_remote_shopping_assistance": false, "companies": UserCompaniesOutput, "compare_list": CompareList, "confirmation_status": "ACCOUNT_CONFIRMED", - "created_at": "xyz789", + "created_at": "abc123", "custom_attributes": [AttributeValueInterface], - "date_of_birth": "abc123", + "date_of_birth": "xyz789", "default_billing": "xyz789", - "default_shipping": "xyz789", - "dob": "xyz789", - "email": "abc123", - "firstname": "abc123", - "gender": 123, + "default_shipping": "abc123", + "dob": "abc123", + "email": "xyz789", + "firstname": "xyz789", + "gender": 987, "gift_registries": [GiftRegistry], "gift_registry": GiftRegistry, - "group": CustomerGroupStorefront, + "group": CustomerGroup, "group_id": 987, - "id": "4", - "is_subscribed": false, + "id": 123, + "is_subscribed": true, "job_title": "abc123", - "lastname": "abc123", + "lastname": "xyz789", "middlename": "xyz789", "orders": CustomerOrders, - "prefix": "abc123", + "prefix": "xyz789", "purchase_order": PurchaseOrder, "purchase_order_approval_rule": PurchaseOrderApprovalRule, "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata, @@ -3432,14 +3422,14 @@Response
"reviews": ProductReviews, "reward_points": RewardPoints, "role": CompanyRole, - "segments": [CustomerSegmentStorefront], + "segments": [CustomerSegment], "status": "ACTIVE", "store_credit": CustomerStoreCredit, "structure_id": 4, "suffix": "xyz789", - "taxvat": "xyz789", + "taxvat": "abc123", "team": CompanyTeam, - "telephone": "xyz789", + "telephone": "abc123", "wishlist": Wishlist, "wishlist_v2": Wishlist, "wishlists": [Wishlist] @@ -3525,7 +3515,7 @@Query
} printed_card_included rules { - ...CartRuleStorefrontFragment + ...CartRuleFragment } selected_payment_method { ...SelectedPaymentMethodFragment @@ -3555,15 +3545,15 @@Response
"billing_address": BillingCartAddress, "email": "abc123", "gift_message": GiftMessage, - "gift_receipt_included": true, + "gift_receipt_included": false, "gift_wrapping": GiftWrapping, "id": 4, - "is_virtual": false, + "is_virtual": true, "items": [CartItemInterface], "itemsV2": CartItems, "prices": CartPrices, "printed_card_included": false, - "rules": [CartRuleStorefront], + "rules": [CartRule], "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], "total_quantity": 123.45 @@ -3620,48 +3610,6 @@Response
} } } - -
- customerGroup
-
- Description
-Provides Customer Group assigned to the Customer or Guest.
-Response
- Returns a CustomerGroupStorefront!
-
Example
-Query
-query customerGroup {
- customerGroup {
- uid
- }
-}
-
- Response
-{"data": {"customerGroup": {"uid": "4"}}}
Response
"customerPaymentTokens": {"items": [PaymentToken]} } } - -
- customerSegments
-
- Description
-Customer segments associated with the current customer or guest/visitor.
-Response
- Returns [CustomerSegmentStorefront]
-
Arguments
-| Name | -Description | -
|---|---|
- cartId - String!
- |
- The unique ID of the cart to query. | -
Example
-Query
-query customerSegments($cartId: String!) {
- customerSegments(cartId: $cartId) {
- uid
- }
-}
-
- Variables
-{"cartId": "xyz789"}
-
- Response
-{
- "data": {
- "customerSegments": [{"uid": "4"}]
- }
-}
Response
"dynamicBlocks": { "items": [DynamicBlock], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } } } @@ -4086,7 +3964,7 @@Response
"getPayflowLinkToken": { "mode": "TEST", "paypal_url": "abc123", - "secure_token": "abc123", + "secure_token": "xyz789", "secure_token_id": "abc123" } } @@ -4147,9 +4025,6 @@Query
apple_pay { ...ApplePayConfigFragment } - fastlane { - ...FastlaneConfigFragment - } google_pay { ...GooglePayConfigFragment } @@ -4174,7 +4049,6 @@Response
"data": { "getPaymentConfig": { "apple_pay": ApplePayConfig, - "fastlane": FastlaneConfig, "google_pay": GooglePayConfig, "hosted_fields": HostedFieldsConfig, "smart_buttons": SmartButtonsConfig @@ -4259,8 +4133,8 @@Query
Variables
{
- "cartId": "abc123",
- "id": "abc123"
+ "cartId": "xyz789",
+ "id": "xyz789"
}
Response
"data": { "getPaymentOrder": { "id": "xyz789", - "mp_order_id": "xyz789", + "mp_order_id": "abc123", "payment_source_details": PaymentSourceDetails, - "status": "abc123" + "status": "xyz789" } } } @@ -4472,7 +4346,7 @@Response
"giftCardAccount": { "balance": Money, "code": "xyz789", - "expiration_date": "xyz789" + "expiration_date": "abc123" } } } @@ -4557,7 +4431,7 @@Query
Variables
-{"giftRegistryUid": 4}
+ {"giftRegistryUid": "4"}
Response
{
"data": {
"giftRegistry": {
- "created_at": "xyz789",
+ "created_at": "abc123",
"dynamic_attributes": [
GiftRegistryDynamicAttribute
],
"event_name": "abc123",
"items": [GiftRegistryItemInterface],
"message": "xyz789",
- "owner_name": "xyz789",
+ "owner_name": "abc123",
"privacy_settings": "PRIVATE",
"registrants": [GiftRegistryRegistrant],
"shipping_address": CustomerAddress,
@@ -4647,7 +4521,7 @@ Query
Variables
-{"email": "xyz789"}
+ {"email": "abc123"}
Response
{ "event_date": "xyz789", "event_title": "abc123", - "gift_registry_uid": 4, - "location": "abc123", - "name": "xyz789", + "gift_registry_uid": "4", + "location": "xyz789", + "name": "abc123", "type": "abc123" } ] @@ -4731,7 +4605,7 @@Query
Variables
-{"giftRegistryUid": "4"}
+ {"giftRegistryUid": 4}
Response
"giftRegistryIdSearch": [ { "event_date": "xyz789", - "event_title": "abc123", + "event_title": "xyz789", "gift_registry_uid": "4", - "location": "xyz789", + "location": "abc123", "name": "abc123", - "type": "xyz789" + "type": "abc123" } ] } @@ -4955,7 +4829,7 @@Arguments
input - GuestOrderInformationInput!
+ input - OrderInformationInput!
Arguments
Example
Query
-query guestOrder($input: GuestOrderInformationInput!) {
+ query guestOrder($input: OrderInformationInput!) {
guestOrder(input: $input) {
applied_coupons {
...AppliedCouponFragment
@@ -5041,7 +4915,7 @@ Query
Variables
-{"input": GuestOrderInformationInput}
+ {"input": OrderInformationInput}
Response
"applied_gift_cards": [ApplyGiftCardToOrder], "available_actions": ["REORDER"], "billing_address": OrderAddress, - "carrier": "abc123", + "carrier": "xyz789", "comments": [SalesCommentItem], "created_at": "abc123", "credit_memos": [CreditMemo], "customer_info": OrderCustomerInfo, "email": "xyz789", "gift_message": GiftMessage, - "gift_receipt_included": false, + "gift_receipt_included": true, "gift_wrapping": GiftWrapping, - "grand_total": 123.45, - "id": "4", - "increment_id": "abc123", + "grand_total": 987.65, + "id": 4, + "increment_id": "xyz789", "invoices": [Invoice], "is_virtual": true, "items": [OrderItemInterface], "items_eligible_for_return": [OrderItemInterface], - "number": "xyz789", - "order_date": "xyz789", + "number": "abc123", + "order_date": "abc123", "order_number": "xyz789", - "order_status_change_date": "abc123", + "order_status_change_date": "xyz789", "payment_methods": [OrderPaymentMethod], "printed_card_included": false, "returns": Returns, "shipments": [OrderShipment], "shipping_address": OrderAddress, "shipping_method": "xyz789", - "status": "xyz789", + "status": "abc123", "token": "xyz789", "total": OrderTotal } @@ -5224,16 +5098,16 @@Response
"billing_address": OrderAddress, "carrier": "abc123", "comments": [SalesCommentItem], - "created_at": "xyz789", + "created_at": "abc123", "credit_memos": [CreditMemo], "customer_info": OrderCustomerInfo, - "email": "abc123", + "email": "xyz789", "gift_message": GiftMessage, - "gift_receipt_included": true, + "gift_receipt_included": false, "gift_wrapping": GiftWrapping, - "grand_total": 123.45, - "id": 4, - "increment_id": "xyz789", + "grand_total": 987.65, + "id": "4", + "increment_id": "abc123", "invoices": [Invoice], "is_virtual": true, "items": [OrderItemInterface], @@ -5382,12 +5256,12 @@Query
Variables
-{"email": "abc123"}
+ {"email": "xyz789"}
Response
-{"data": {"isCompanyEmailAvailable": {"is_email_available": true}}}
+ {"data": {"isCompanyEmailAvailable": {"is_email_available": false}}}
Variables
Response
-{"data": {"isCompanyRoleNameAvailable": {"is_role_name_available": false}}}
+ {"data": {"isCompanyRoleNameAvailable": {"is_role_name_available": true}}}
Variables
Response
-{"data": {"isCompanyUserEmailAvailable": {"is_email_available": false}}}
+ {"data": {"isCompanyUserEmailAvailable": {"is_email_available": true}}}
Query
Variables
-{"uid": 4}
+ {"uid": "4"}
Response
"billing_address": NegotiableQuoteBillingAddress, "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "created_at": "xyz789", - "email": "xyz789", + "created_at": "abc123", + "email": "abc123", "history": [NegotiableQuoteHistoryEntry], - "is_virtual": false, + "is_virtual": true, "items": [CartItemInterface], "name": "abc123", "prices": CartPrices, @@ -5709,7 +5583,7 @@Response
NegotiableQuoteShippingAddress ], "status": "SUBMITTED", - "total_quantity": 123.45, + "total_quantity": 987.65, "uid": 4, "updated_at": "xyz789" } @@ -5808,7 +5682,7 @@Query
Variables
-{"templateId": 4}
+ {"templateId": "4"}
Response
"comments": [NegotiableQuoteComment], "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], - "is_min_max_qty_used": false, - "is_virtual": true, + "is_min_max_qty_used": true, + "is_virtual": false, "items": [CartItemInterface], - "max_order_commitment": 123, + "max_order_commitment": 987, "min_order_commitment": 123, "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], @@ -5834,9 +5708,9 @@Response
"shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "xyz789", - "template_id": 4, - "total_quantity": 987.65 + "status": "abc123", + "template_id": "4", + "total_quantity": 123.45 } } } @@ -5953,7 +5827,7 @@Response
"items": [NegotiableQuoteTemplateGridItem], "page_info": SearchResultPageInfo, "sort_fields": SortFields, - "total_count": 123 + "total_count": 987 } } } @@ -6070,7 +5944,7 @@Response
"items": [NegotiableQuote], "page_info": SearchResultPageInfo, "sort_fields": SortFields, - "total_count": 987 + "total_count": 123 } } } @@ -6389,7 +6263,7 @@Response
"page_info": SearchResultPageInfo, "sort_fields": SortFields, "suggestions": [SearchSuggestion], - "total_count": 987 + "total_count": 123 } } } @@ -6518,7 +6392,7 @@Response
"forms": ["PLACE_ORDER"], "is_enabled": false, "language_code": "abc123", - "minimum_score": 123.45, + "minimum_score": 987.65, "theme": "abc123", "website_key": "abc123" } @@ -6586,7 +6460,7 @@Query
Variables
-{"url": "xyz789"}
+ {"url": "abc123"}
Query
braintree_paypal_vault_active cart_expires_in_days cart_gift_wrapping - cart_merge_preference cart_printed_card cart_summary_display_quantity catalog_default_sort_by @@ -6772,6 +6645,7 @@Query
fixed_product_taxes_enable fixed_product_taxes_include_fpt_in_subtotal front + graphql_share_all_customer_groups graphql_share_customer_group grid_per_page grid_per_page_values @@ -6849,8 +6723,10 @@Query
send_friend { ...SendFriendConfigurationFragment } - share_active_segments - share_applied_cart_rule + share_all_catalog_rules + share_all_sales_rule + share_applied_catalog_rules + share_applied_sales_rule shopping_cart_display_full_summary shopping_cart_display_grand_total shopping_cart_display_price @@ -6894,243 +6770,245 @@Response
"allow_gift_receipt": "xyz789", "allow_gift_wrapping_on_order": "abc123", "allow_gift_wrapping_on_order_items": "abc123", - "allow_guests_to_write_product_reviews": "abc123", - "allow_items": "xyz789", - "allow_order": "abc123", + "allow_guests_to_write_product_reviews": "xyz789", + "allow_items": "abc123", + "allow_order": "xyz789", "allow_printed_card": "abc123", - "autocomplete_on_storefront": true, + "autocomplete_on_storefront": false, "base_currency_code": "abc123", "base_link_url": "abc123", "base_media_url": "xyz789", - "base_static_url": "xyz789", + "base_static_url": "abc123", "base_url": "abc123", - "braintree_3dsecure_allowspecific": false, - "braintree_3dsecure_always_request_3ds": false, - "braintree_3dsecure_specificcountry": "xyz789", + "braintree_3dsecure_allowspecific": true, + "braintree_3dsecure_always_request_3ds": true, + "braintree_3dsecure_specificcountry": "abc123", "braintree_3dsecure_threshold_amount": "abc123", - "braintree_3dsecure_verify_3dsecure": true, + "braintree_3dsecure_verify_3dsecure": false, "braintree_ach_direct_debit_vault_active": false, "braintree_applepay_merchant_name": "abc123", "braintree_applepay_vault_active": false, "braintree_cc_vault_active": "abc123", - "braintree_cc_vault_cvv": false, - "braintree_environment": "xyz789", - "braintree_googlepay_btn_color": "abc123", + "braintree_cc_vault_cvv": true, + "braintree_environment": "abc123", + "braintree_googlepay_btn_color": "xyz789", "braintree_googlepay_cctypes": "abc123", - "braintree_googlepay_merchant_id": "abc123", - "braintree_googlepay_vault_active": true, - "braintree_local_payment_allowed_methods": "xyz789", - "braintree_local_payment_fallback_button_text": "xyz789", - "braintree_local_payment_redirect_on_fail": "xyz789", + "braintree_googlepay_merchant_id": "xyz789", + "braintree_googlepay_vault_active": false, + "braintree_local_payment_allowed_methods": "abc123", + "braintree_local_payment_fallback_button_text": "abc123", + "braintree_local_payment_redirect_on_fail": "abc123", "braintree_merchant_account_id": "abc123", - "braintree_paypal_button_location_cart_type_credit_color": "xyz789", + "braintree_paypal_button_location_cart_type_credit_color": "abc123", "braintree_paypal_button_location_cart_type_credit_label": "abc123", - "braintree_paypal_button_location_cart_type_credit_shape": "xyz789", - "braintree_paypal_button_location_cart_type_credit_show": true, - "braintree_paypal_button_location_cart_type_messaging_layout": "abc123", + "braintree_paypal_button_location_cart_type_credit_shape": "abc123", + "braintree_paypal_button_location_cart_type_credit_show": false, + "braintree_paypal_button_location_cart_type_messaging_layout": "xyz789", "braintree_paypal_button_location_cart_type_messaging_logo": "xyz789", "braintree_paypal_button_location_cart_type_messaging_logo_position": "xyz789", "braintree_paypal_button_location_cart_type_messaging_show": false, - "braintree_paypal_button_location_cart_type_messaging_text_color": "abc123", - "braintree_paypal_button_location_cart_type_paylater_color": "xyz789", + "braintree_paypal_button_location_cart_type_messaging_text_color": "xyz789", + "braintree_paypal_button_location_cart_type_paylater_color": "abc123", "braintree_paypal_button_location_cart_type_paylater_label": "abc123", "braintree_paypal_button_location_cart_type_paylater_shape": "abc123", "braintree_paypal_button_location_cart_type_paylater_show": true, - "braintree_paypal_button_location_cart_type_paypal_color": "abc123", - "braintree_paypal_button_location_cart_type_paypal_label": "xyz789", + "braintree_paypal_button_location_cart_type_paypal_color": "xyz789", + "braintree_paypal_button_location_cart_type_paypal_label": "abc123", "braintree_paypal_button_location_cart_type_paypal_shape": "xyz789", "braintree_paypal_button_location_cart_type_paypal_show": true, "braintree_paypal_button_location_checkout_type_credit_color": "xyz789", "braintree_paypal_button_location_checkout_type_credit_label": "abc123", "braintree_paypal_button_location_checkout_type_credit_shape": "xyz789", - "braintree_paypal_button_location_checkout_type_credit_show": false, - "braintree_paypal_button_location_checkout_type_messaging_layout": "abc123", + "braintree_paypal_button_location_checkout_type_credit_show": true, + "braintree_paypal_button_location_checkout_type_messaging_layout": "xyz789", "braintree_paypal_button_location_checkout_type_messaging_logo": "xyz789", - "braintree_paypal_button_location_checkout_type_messaging_logo_position": "xyz789", + "braintree_paypal_button_location_checkout_type_messaging_logo_position": "abc123", "braintree_paypal_button_location_checkout_type_messaging_show": true, - "braintree_paypal_button_location_checkout_type_messaging_text_color": "abc123", + "braintree_paypal_button_location_checkout_type_messaging_text_color": "xyz789", "braintree_paypal_button_location_checkout_type_paylater_color": "abc123", "braintree_paypal_button_location_checkout_type_paylater_label": "abc123", - "braintree_paypal_button_location_checkout_type_paylater_shape": "abc123", - "braintree_paypal_button_location_checkout_type_paylater_show": true, + "braintree_paypal_button_location_checkout_type_paylater_shape": "xyz789", + "braintree_paypal_button_location_checkout_type_paylater_show": false, "braintree_paypal_button_location_checkout_type_paypal_color": "abc123", - "braintree_paypal_button_location_checkout_type_paypal_label": "abc123", + "braintree_paypal_button_location_checkout_type_paypal_label": "xyz789", "braintree_paypal_button_location_checkout_type_paypal_shape": "xyz789", "braintree_paypal_button_location_checkout_type_paypal_show": true, - "braintree_paypal_button_location_productpage_type_credit_color": "abc123", + "braintree_paypal_button_location_productpage_type_credit_color": "xyz789", "braintree_paypal_button_location_productpage_type_credit_label": "abc123", - "braintree_paypal_button_location_productpage_type_credit_shape": "abc123", + "braintree_paypal_button_location_productpage_type_credit_shape": "xyz789", "braintree_paypal_button_location_productpage_type_credit_show": true, - "braintree_paypal_button_location_productpage_type_messaging_layout": "xyz789", + "braintree_paypal_button_location_productpage_type_messaging_layout": "abc123", "braintree_paypal_button_location_productpage_type_messaging_logo": "abc123", "braintree_paypal_button_location_productpage_type_messaging_logo_position": "xyz789", - "braintree_paypal_button_location_productpage_type_messaging_show": true, + "braintree_paypal_button_location_productpage_type_messaging_show": false, "braintree_paypal_button_location_productpage_type_messaging_text_color": "abc123", "braintree_paypal_button_location_productpage_type_paylater_color": "abc123", - "braintree_paypal_button_location_productpage_type_paylater_label": "abc123", - "braintree_paypal_button_location_productpage_type_paylater_shape": "abc123", + "braintree_paypal_button_location_productpage_type_paylater_label": "xyz789", + "braintree_paypal_button_location_productpage_type_paylater_shape": "xyz789", "braintree_paypal_button_location_productpage_type_paylater_show": false, - "braintree_paypal_button_location_productpage_type_paypal_color": "xyz789", + "braintree_paypal_button_location_productpage_type_paypal_color": "abc123", "braintree_paypal_button_location_productpage_type_paypal_label": "xyz789", - "braintree_paypal_button_location_productpage_type_paypal_shape": "xyz789", - "braintree_paypal_button_location_productpage_type_paypal_show": true, - "braintree_paypal_credit_uk_merchant_name": "abc123", - "braintree_paypal_display_on_shopping_cart": true, - "braintree_paypal_merchant_country": "abc123", - "braintree_paypal_merchant_name_override": "xyz789", + "braintree_paypal_button_location_productpage_type_paypal_shape": "abc123", + "braintree_paypal_button_location_productpage_type_paypal_show": false, + "braintree_paypal_credit_uk_merchant_name": "xyz789", + "braintree_paypal_display_on_shopping_cart": false, + "braintree_paypal_merchant_country": "xyz789", + "braintree_paypal_merchant_name_override": "abc123", "braintree_paypal_require_billing_address": true, "braintree_paypal_send_cart_line_items": true, "braintree_paypal_vault_active": true, - "cart_expires_in_days": 987, - "cart_gift_wrapping": "abc123", - "cart_merge_preference": "xyz789", + "cart_expires_in_days": 123, + "cart_gift_wrapping": "xyz789", "cart_printed_card": "abc123", - "cart_summary_display_quantity": 987, - "catalog_default_sort_by": "abc123", + "cart_summary_display_quantity": 123, + "catalog_default_sort_by": "xyz789", "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", "category_url_suffix": "xyz789", - "check_money_order_enable_for_specific_countries": true, - "check_money_order_enabled": false, + "check_money_order_enable_for_specific_countries": false, + "check_money_order_enabled": true, "check_money_order_make_check_payable_to": "abc123", - "check_money_order_max_order_total": "abc123", - "check_money_order_min_order_total": "xyz789", - "check_money_order_new_order_status": "xyz789", - "check_money_order_payment_from_specific_countries": "abc123", - "check_money_order_send_check_to": "xyz789", - "check_money_order_sort_order": 987, + "check_money_order_max_order_total": "xyz789", + "check_money_order_min_order_total": "abc123", + "check_money_order_new_order_status": "abc123", + "check_money_order_payment_from_specific_countries": "xyz789", + "check_money_order_send_check_to": "abc123", + "check_money_order_sort_order": 123, "check_money_order_title": "xyz789", - "cms_home_page": "xyz789", + "cms_home_page": "abc123", "cms_no_cookies": "abc123", "cms_no_route": "abc123", - "code": "xyz789", + "code": "abc123", "configurable_product_image": "ITSELF", - "configurable_thumbnail_source": "xyz789", + "configurable_thumbnail_source": "abc123", "contact_enabled": false, "copyright": "abc123", - "countries_with_required_region": "abc123", + "countries_with_required_region": "xyz789", "create_account_confirmation": true, "customer_access_token_lifetime": 987.65, "default_country": "xyz789", "default_description": "xyz789", "default_display_currency_code": "abc123", "default_keywords": "xyz789", - "default_title": "xyz789", + "default_title": "abc123", "demonotice": 123, - "display_product_prices_in_catalog": 987, + "display_product_prices_in_catalog": 123, "display_shipping_prices": 987, - "display_state_if_optional": false, + "display_state_if_optional": true, "enable_multiple_wishlists": "abc123", "fixed_product_taxes_apply_tax_to_fpt": false, - "fixed_product_taxes_display_prices_in_emails": 987, + "fixed_product_taxes_display_prices_in_emails": 123, "fixed_product_taxes_display_prices_in_product_lists": 987, - "fixed_product_taxes_display_prices_in_sales_modules": 987, - "fixed_product_taxes_display_prices_on_product_view_page": 123, + "fixed_product_taxes_display_prices_in_sales_modules": 123, + "fixed_product_taxes_display_prices_on_product_view_page": 987, "fixed_product_taxes_enable": false, "fixed_product_taxes_include_fpt_in_subtotal": true, "front": "abc123", + "graphql_share_all_customer_groups": true, "graphql_share_customer_group": false, "grid_per_page": 123, "grid_per_page_values": "abc123", "grouped_product_image": "ITSELF", - "head_includes": "abc123", - "head_shortcut_icon": "abc123", - "header_logo_src": "xyz789", - "id": 987, + "head_includes": "xyz789", + "head_shortcut_icon": "xyz789", + "header_logo_src": "abc123", + "id": 123, "is_checkout_agreements_enabled": false, "is_default_store": false, "is_default_store_group": true, - "is_guest_checkout_enabled": true, - "is_negotiable_quote_active": false, + "is_guest_checkout_enabled": false, + "is_negotiable_quote_active": true, "is_one_page_checkout_enabled": true, - "is_requisition_list_active": "xyz789", - "list_mode": "abc123", + "is_requisition_list_active": "abc123", + "list_mode": "xyz789", "list_per_page": 987, - "list_per_page_values": "abc123", + "list_per_page_values": "xyz789", "locale": "xyz789", - "logo_alt": "abc123", - "logo_height": 987, + "logo_alt": "xyz789", + "logo_height": 123, "logo_width": 123, - "magento_reward_general_is_enabled": "xyz789", - "magento_reward_general_is_enabled_on_front": "xyz789", - "magento_reward_general_min_points_balance": "xyz789", + "magento_reward_general_is_enabled": "abc123", + "magento_reward_general_is_enabled_on_front": "abc123", + "magento_reward_general_min_points_balance": "abc123", "magento_reward_general_publish_history": "xyz789", - "magento_reward_points_invitation_customer": "abc123", - "magento_reward_points_invitation_customer_limit": "abc123", + "magento_reward_points_invitation_customer": "xyz789", + "magento_reward_points_invitation_customer_limit": "xyz789", "magento_reward_points_invitation_order": "xyz789", "magento_reward_points_invitation_order_limit": "abc123", - "magento_reward_points_newsletter": "xyz789", + "magento_reward_points_newsletter": "abc123", "magento_reward_points_order": "abc123", - "magento_reward_points_register": "abc123", - "magento_reward_points_review": "xyz789", - "magento_reward_points_review_limit": "abc123", + "magento_reward_points_register": "xyz789", + "magento_reward_points_review": "abc123", + "magento_reward_points_review_limit": "xyz789", "magento_wishlist_general_is_enabled": "abc123", - "max_items_in_order_summary": 123, + "max_items_in_order_summary": 987, "maximum_number_of_wishlists": "xyz789", "minicart_display": true, "minicart_max_items": 123, - "minimum_password_length": "xyz789", - "newsletter_enabled": false, + "minimum_password_length": "abc123", + "newsletter_enabled": true, "no_route": "abc123", "optional_zip_countries": "abc123", - "order_cancellation_enabled": true, + "order_cancellation_enabled": false, "order_cancellation_reasons": [CancellationReason], "orders_invoices_credit_memos_display_full_summary": false, "orders_invoices_credit_memos_display_grandtotal": true, "orders_invoices_credit_memos_display_price": 123, - "orders_invoices_credit_memos_display_shipping_amount": 987, - "orders_invoices_credit_memos_display_subtotal": 123, + "orders_invoices_credit_memos_display_shipping_amount": 123, + "orders_invoices_credit_memos_display_subtotal": 987, "orders_invoices_credit_memos_display_zero_tax": true, "payment_payflowpro_cc_vault_active": "abc123", "printed_card_price": "xyz789", "printed_card_priceV2": Money, "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", - "product_reviews_enabled": "xyz789", - "product_url_suffix": "abc123", - "quickorder_active": true, + "product_reviews_enabled": "abc123", + "product_url_suffix": "xyz789", + "quickorder_active": false, "required_character_classes_number": "xyz789", "returns_enabled": "xyz789", "root_category_id": 123, - "root_category_uid": 4, + "root_category_uid": "4", "sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", "sales_gift_wrapping": "xyz789", - "sales_printed_card": "abc123", + "sales_printed_card": "xyz789", "secure_base_link_url": "xyz789", "secure_base_media_url": "xyz789", "secure_base_static_url": "abc123", "secure_base_url": "abc123", "send_friend": SendFriendConfiguration, - "share_active_segments": true, - "share_applied_cart_rule": true, + "share_all_catalog_rules": true, + "share_all_sales_rule": true, + "share_applied_catalog_rules": true, + "share_applied_sales_rule": true, "shopping_cart_display_full_summary": false, - "shopping_cart_display_grand_total": true, - "shopping_cart_display_price": 123, - "shopping_cart_display_shipping": 987, - "shopping_cart_display_subtotal": 987, + "shopping_cart_display_grand_total": false, + "shopping_cart_display_price": 987, + "shopping_cart_display_shipping": 123, + "shopping_cart_display_subtotal": 123, "shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX", - "shopping_cart_display_zero_tax": true, + "shopping_cart_display_zero_tax": false, "show_cms_breadcrumbs": 987, "store_code": 4, "store_group_code": "4", "store_group_name": "abc123", "store_name": "abc123", - "store_sort_order": 123, + "store_sort_order": 987, "timezone": "abc123", - "title_prefix": "xyz789", - "title_separator": "abc123", - "title_suffix": "xyz789", + "title_prefix": "abc123", + "title_separator": "xyz789", + "title_suffix": "abc123", "use_store_in_url": false, - "website_code": 4, + "website_code": "4", "website_id": 123, - "website_name": "xyz789", + "website_name": "abc123", "weight_unit": "abc123", - "welcome": "abc123", + "welcome": "xyz789", "zero_subtotal_enable_for_specific_countries": true, - "zero_subtotal_enabled": true, + "zero_subtotal_enabled": false, "zero_subtotal_new_order_status": "abc123", "zero_subtotal_payment_action": "xyz789", "zero_subtotal_payment_from_specific_countries": "xyz789", - "zero_subtotal_sort_order": 987, - "zero_subtotal_title": "abc123" + "zero_subtotal_sort_order": 123, + "zero_subtotal_title": "xyz789" } } } @@ -7206,7 +7084,7 @@Query
Variables
-{"url": "xyz789"}
+ {"url": "abc123"}
Response
"canonical_url": "abc123", "entity_uid": "4", "id": 123, - "redirectCode": 123, + "redirectCode": 987, "relative_url": "abc123", "type": "CMS_PAGE" } @@ -7282,7 +7160,7 @@Response
"wishlist": { "items": [WishlistItem], "items_count": 987, - "name": "abc123", + "name": "xyz789", "sharing_code": "abc123", "updated_at": "xyz789" } @@ -7457,11 +7335,11 @@Response
"comments": [NegotiableQuoteComment], "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], - "is_min_max_qty_used": true, - "is_virtual": true, + "is_min_max_qty_used": false, + "is_virtual": false, "items": [CartItemInterface], "max_order_commitment": 123, - "min_order_commitment": 987, + "min_order_commitment": 123, "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, @@ -7472,8 +7350,8 @@Response
NegotiableQuoteShippingAddress ], "status": "xyz789", - "template_id": "4", - "total_quantity": 123.45 + "template_id": 4, + "total_quantity": 987.65 } } } @@ -7947,87 +7825,9 @@Response
"data": { "addProductsToCompareList": { "attributes": [ComparableAttribute], - "item_count": 987, + "item_count": 123, "items": [ComparableItem], - "uid": 4 - } - } -} - -
- addProductsToNewCart
-
- Description
-Creates a new cart and add any type of product to it
-Response
- Returns an AddProductsToNewCartOutput
-
Arguments
-| Name | -Description | -
|---|---|
- cartItems - [CartItemInput!]!
- |
- An array that defines the products to add to the new cart | -
Example
-Query
-mutation addProductsToNewCart($cartItems: [CartItemInput!]!) {
- addProductsToNewCart(cartItems: $cartItems) {
- cart {
- ...CartFragment
- }
- user_errors {
- ...CartUserInputErrorFragment
- }
- }
-}
-
- Variables
-{"cartItems": [CartItemInput]}
-
- Response
-{
- "data": {
- "addProductsToNewCart": {
- "cart": Cart,
- "user_errors": [CartUserInputError]
+ "uid": "4"
}
}
}
@@ -8197,7 +7997,10 @@ Query
Variables
-{"wishlistId": 4, "wishlistItems": [WishlistItemInput]}
+ {
+ "wishlistId": "4",
+ "wishlistItems": [WishlistItemInput]
+}
Query
Variables
-{"requisitionListUid": 4, "requisitionListItemUids": [4]}
+ {
+ "requisitionListUid": "4",
+ "requisitionListItemUids": ["4"]
+}
Query
Variables
-{
- "wishlistId": "4",
- "wishlistItemIds": ["4"]
-}
+ {"wishlistId": 4, "wishlistItemIds": [4]}
Response
"add_wishlist_items_to_cart_user_errors": [ WishlistCartUserInputError ], - "status": false, + "status": true, "wishlist": Wishlist } } @@ -9432,7 +9235,7 @@Query
} printed_card_included rules { - ...CartRuleStorefrontFragment + ...CartRuleFragment } selected_payment_method { ...SelectedPaymentMethodFragment @@ -9447,7 +9250,7 @@Query
Variables
-{"cart_id": "abc123"}
+ {"cart_id": "xyz789"}
Response
AvailablePaymentMethod ], "billing_address": BillingCartAddress, - "email": "abc123", + "email": "xyz789", "gift_message": GiftMessage, - "gift_receipt_included": true, + "gift_receipt_included": false, "gift_wrapping": GiftWrapping, "id": 4, "is_virtual": true, @@ -9475,10 +9278,10 @@Response
"itemsV2": CartItems, "prices": CartPrices, "printed_card_included": true, - "rules": [CartRuleStorefront], + "rules": [CartRule], "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], - "total_quantity": 123.45 + "total_quantity": 987.65 } } } @@ -9602,7 +9405,7 @@Response
], "status": "xyz789", "template_id": 4, - "total_quantity": 987.65 + "total_quantity": 123.45 } } } @@ -9681,7 +9484,7 @@Response
{
"data": {
"cancelOrder": {
- "error": "xyz789",
+ "error": "abc123",
"errorV2": CancelOrderError,
"order": CustomerOrder
}
@@ -9863,7 +9666,7 @@ Query
...GiftRegistryFragment
}
group {
- ...CustomerGroupStorefrontFragment
+ ...CustomerGroupFragment
}
group_id
id
@@ -9910,7 +9713,7 @@ Query
...CompanyRoleFragment
}
segments {
- ...CustomerSegmentStorefrontFragment
+ ...CustomerSegmentFragment
}
status
store_credit {
@@ -9940,7 +9743,7 @@ Query
Variables
{
"currentPassword": "xyz789",
- "newPassword": "xyz789"
+ "newPassword": "abc123"
}
Response
"confirmation_status": "ACCOUNT_CONFIRMED", "created_at": "xyz789", "custom_attributes": [AttributeValueInterface], - "date_of_birth": "xyz789", - "default_billing": "abc123", + "date_of_birth": "abc123", + "default_billing": "xyz789", "default_shipping": "xyz789", "dob": "abc123", "email": "abc123", @@ -9966,13 +9769,13 @@Response
"gender": 123, "gift_registries": [GiftRegistry], "gift_registry": GiftRegistry, - "group": CustomerGroupStorefront, + "group": CustomerGroup, "group_id": 987, - "id": "4", - "is_subscribed": true, + "id": 123, + "is_subscribed": false, "job_title": "abc123", - "lastname": "xyz789", - "middlename": "xyz789", + "lastname": "abc123", + "middlename": "abc123", "orders": CustomerOrders, "prefix": "abc123", "purchase_order": PurchaseOrder, @@ -9987,14 +9790,14 @@Response
"reviews": ProductReviews, "reward_points": RewardPoints, "role": CompanyRole, - "segments": [CustomerSegmentStorefront], + "segments": [CustomerSegment], "status": "ACTIVE", "store_credit": CustomerStoreCredit, - "structure_id": 4, - "suffix": "xyz789", + "structure_id": "4", + "suffix": "abc123", "taxvat": "abc123", "team": CompanyTeam, - "telephone": "abc123", + "telephone": "xyz789", "wishlist": Wishlist, "wishlist_v2": Wishlist, "wishlists": [Wishlist] @@ -10152,84 +9955,6 @@Response
"clearCustomerCart": {"cart": Cart, "status": false} } } - -
- clearWishlist
-
- Description
-Remove all the products from the specified wish list.
-Response
- Returns a RemoveProductsFromWishlistOutput
-
Arguments
-| Name | -Description | -
|---|---|
- wishlistId - ID!
- |
- The ID of a wish list. | -
Example
-Query
-mutation clearWishlist($wishlistId: ID!) {
- clearWishlist(wishlistId: $wishlistId) {
- user_errors {
- ...WishListUserInputErrorFragment
- }
- wishlist {
- ...WishlistFragment
- }
- }
-}
-
- Variables
-{"wishlistId": 4}
-
- Response
-{
- "data": {
- "clearWishlist": {
- "user_errors": [WishListUserInputError],
- "wishlist": Wishlist
- }
- }
-}
Response
} } } - -
- completeOrder
-
- Description
-Synchronizes order details and place the order
-Response
- Returns a PlaceOrderOutput
-
Arguments
-| Name | -Description | -
|---|---|
- input - CompleteOrderInput
- |
- Describes the variables needed to complete or place the order | -
Example
-Query
-mutation completeOrder($input: CompleteOrderInput) {
- completeOrder(input: $input) {
- errors {
- ...PlaceOrderErrorFragment
- }
- order {
- ...OrderFragment
- }
- orderV2 {
- ...CustomerOrderFragment
- }
- }
-}
-
- Variables
-{"input": CompleteOrderInput}
-
- Response
-{
- "data": {
- "completeOrder": {
- "errors": [PlaceOrderError],
- "order": Order,
- "orderV2": CustomerOrder
- }
- }
-}
Variables
Response
-{"data": {"contactUs": {"status": false}}}
+ {"data": {"contactUs": {"status": true}}}
Query
Variables
{
- "sourceRequisitionListUid": 4,
+ "sourceRequisitionListUid": "4",
"destinationRequisitionListUid": "4",
"requisitionListItem": CopyItemsBetweenRequisitionListsInput
}
@@ -10885,7 +10528,7 @@ Query
Variables
{
"sourceWishlistUid": "4",
- "destinationWishlistUid": 4,
+ "destinationWishlistUid": "4",
"wishlistItems": [WishlistItemCopyInput]
}
@@ -10942,7 +10585,7 @@ Query
Response
{
"data": {
- "createBraintreeClientToken": "abc123"
+ "createBraintreeClientToken": "xyz789"
}
}
@@ -11055,7 +10698,7 @@ Variables
Response
{
"data": {
- "createBraintreePayPalVaultClientToken": "abc123"
+ "createBraintreePayPalVaultClientToken": "xyz789"
}
}
@@ -11413,7 +11056,7 @@ Response
"attributes": [ComparableAttribute],
"item_count": 987,
"items": [ComparableItem],
- "uid": 4
+ "uid": "4"
}
}
}
@@ -11568,7 +11211,6 @@ Query
street
suffix
telephone
- uid
vat_id
}
}
@@ -11585,29 +11227,28 @@ Response
"data": {
"createCustomerAddress": {
"city": "abc123",
- "company": "xyz789",
+ "company": "abc123",
"country_code": "AF",
"country_id": "abc123",
"custom_attributes": [CustomerAddressAttribute],
"custom_attributesV2": [AttributeValueInterface],
"customer_id": 987,
"default_billing": true,
- "default_shipping": false,
+ "default_shipping": true,
"extension_attributes": [CustomerAddressAttribute],
- "fax": "abc123",
- "firstname": "abc123",
- "id": 987,
- "lastname": "abc123",
+ "fax": "xyz789",
+ "firstname": "xyz789",
+ "id": 123,
+ "lastname": "xyz789",
"middlename": "xyz789",
- "postcode": "abc123",
+ "postcode": "xyz789",
"prefix": "xyz789",
"region": CustomerAddressRegion,
- "region_id": 987,
- "street": ["abc123"],
+ "region_id": 123,
+ "street": ["xyz789"],
"suffix": "xyz789",
- "telephone": "abc123",
- "uid": 4,
- "vat_id": "xyz789"
+ "telephone": "xyz789",
+ "vat_id": "abc123"
}
}
}
@@ -11749,7 +11390,7 @@ Variables
Response
-{"data": {"createEmptyCart": "abc123"}}
+ {"data": {"createEmptyCart": "xyz789"}}
Response
"createPayflowProToken": { "response_message": "xyz789", "result": 987, - "result_code": 123, - "secure_token": "abc123", + "result_code": 987, + "secure_token": "xyz789", "secure_token_id": "xyz789" } } @@ -12043,10 +11684,10 @@Response
{
"data": {
"createPaymentOrder": {
- "amount": 123.45,
+ "amount": 987.65,
"currency_code": "abc123",
- "id": "xyz789",
- "mp_order_id": "abc123",
+ "id": "abc123",
+ "mp_order_id": "xyz789",
"status": "xyz789"
}
}
@@ -12123,7 +11764,7 @@ Response
"data": {
"createPaypalExpressToken": {
"paypal_urls": PaypalExpressUrlList,
- "token": "xyz789"
+ "token": "abc123"
}
}
}
@@ -12287,12 +11928,12 @@ Response
"approver_roles": [CompanyRole],
"condition": PurchaseOrderApprovalRuleConditionInterface,
"created_at": "xyz789",
- "created_by": "abc123",
- "description": "xyz789",
- "name": "abc123",
+ "created_by": "xyz789",
+ "description": "abc123",
+ "name": "xyz789",
"status": "ENABLED",
"uid": 4,
- "updated_at": "abc123"
+ "updated_at": "xyz789"
}
}
}
@@ -12443,7 +12084,7 @@ Response
"data": {
"createVaultCardPaymentToken": {
"payment_source": PaymentSourceOutput,
- "vault_token_id": "xyz789"
+ "vault_token_id": "abc123"
}
}
}
@@ -12515,7 +12156,7 @@ Response
{
"data": {
"createVaultCardSetupToken": {
- "setup_token": "xyz789"
+ "setup_token": "abc123"
}
}
}
@@ -12648,12 +12289,12 @@ Query
Variables
- {"id": "4"}
+ {"id": 4}
Response
- {"data": {"deleteCompanyRole": {"success": false}}}
+ {"data": {"deleteCompanyRole": {"success": true}}}
@@ -12706,82 +12347,8 @@ Arguments
Example
Query
- mutation deleteCompanyTeam($id: ID!) {
- deleteCompanyTeam(id: $id) {
- success
- }
-}
-
-
-
- Variables
- {"id": 4}
-
-
-
- Response
- {"data": {"deleteCompanyTeam": {"success": true}}}
-
-
-
-
-
- deleteCompanyUser
-
- Description
-Delete the specified company user.
-Response
- Returns a DeleteCompanyUserOutput
-
Arguments
-| Name | -Description | -
|---|---|
- id - ID!
- |
- - | -
Example
-Query
-mutation deleteCompanyUser($id: ID!) {
- deleteCompanyUser(id: $id) {
+ mutation deleteCompanyTeam($id: ID!) {
+ deleteCompanyTeam(id: $id) {
success
}
}
@@ -12789,24 +12356,31 @@ Query
Variables
-{"id": "4"}
+ {"id": 4}
Response
-{"data": {"deleteCompanyUser": {"success": true}}}
+ {"data": {"deleteCompanyTeam": {"success": true}}}
- deleteCompanyUserV2
+
+ deleteCompanyUser
+
+
+
+ Use deleteCompanyUserV2 instead. The current method only deactivates the user account associated with the company.
+
+
+
@@ -12847,8 +12421,8 @@ Arguments
Example
Query
- mutation deleteCompanyUserV2($id: ID!) {
- deleteCompanyUserV2(id: $id) {
+ mutation deleteCompanyUser($id: ID!) {
+ deleteCompanyUser(id: $id) {
success
}
}
@@ -12856,29 +12430,29 @@ Query
Variables
- {"id": "4"}
+ {"id": 4}
Response
- {"data": {"deleteCompanyUserV2": {"success": false}}}
+ {"data": {"deleteCompanyUser": {"success": true}}}
-
+
- deleteCompareList
+ deleteCompanyUserV2
Description
- Delete the specified compare list.
+ Delete the specified company user.
@@ -12886,7 +12460,7 @@ Description
@@ -12901,9 +12475,10 @@ Arguments
- uid - ID!
+ id - ID!
+
+
- The unique ID of the compare list to be deleted.
@@ -12913,38 +12488,38 @@ Arguments
Example
Query
- mutation deleteCompareList($uid: ID!) {
- deleteCompareList(uid: $uid) {
- result
+ mutation deleteCompanyUserV2($id: ID!) {
+ deleteCompanyUserV2(id: $id) {
+ success
}
}
Variables
- {"uid": 4}
+ {"id": 4}
Response
- {"data": {"deleteCompareList": {"result": false}}}
+ {"data": {"deleteCompanyUserV2": {"success": true}}}
-
+
- deleteCustomer
+ deleteCompareList
Description
- Delete customer account
+ Delete the specified compare list.
@@ -12952,46 +12527,65 @@ Description
+
+ Arguments
+
+
+
+ Name
+ Description
+
+
+
+
+
+ uid - ID!
+
+ The unique ID of the compare list to be deleted.
+
+
+
+
Example
Query
- mutation deleteCustomer {
- deleteCustomer
+ mutation deleteCompareList($uid: ID!) {
+ deleteCompareList(uid: $uid) {
+ result
+ }
}
+
+
+
+ Variables
+ {"uid": "4"}
Response
- {"data": {"deleteCustomer": false}}
+ {"data": {"deleteCompareList": {"result": true}}}
deleteCompanyUser
Arguments
Example
Query
-mutation deleteCompanyUserV2($id: ID!) {
- deleteCompanyUserV2(id: $id) {
+ mutation deleteCompanyUser($id: ID!) {
+ deleteCompanyUser(id: $id) {
success
}
}
@@ -12856,29 +12430,29 @@ Query
Variables
-{"id": "4"}
+ {"id": 4}
Response
-{"data": {"deleteCompanyUserV2": {"success": false}}}
+ {"data": {"deleteCompanyUser": {"success": true}}}
- deleteCompareList
+ deleteCompanyUserV2
Description
-Delete the specified compare list.
+Delete the specified company user.
Description
Arguments
uid - ID!
+ id - ID!
+ Arguments
Example
Query
-mutation deleteCompareList($uid: ID!) {
- deleteCompareList(uid: $uid) {
- result
+ mutation deleteCompanyUserV2($id: ID!) {
+ deleteCompanyUserV2(id: $id) {
+ success
}
}
Variables
-{"uid": 4}
+ {"id": 4}
Response
-{"data": {"deleteCompareList": {"result": false}}}
+ {"data": {"deleteCompanyUserV2": {"success": true}}}
- deleteCustomer
+ deleteCompareList
Description
-Delete customer account
+Delete the specified compare list.
Description
Arguments
+| Name | +Description | +
|---|---|
+ uid - ID!
+ |
+ The unique ID of the compare list to be deleted. | +
Example
Query
-mutation deleteCustomer {
- deleteCustomer
+ mutation deleteCompareList($uid: ID!) {
+ deleteCompareList(uid: $uid) {
+ result
+ }
}
+
+ Variables
+{"uid": "4"}
Response
-{"data": {"deleteCustomer": false}}
+ {"data": {"deleteCompareList": {"result": true}}}
- deleteCustomerAddress
+
+ deleteCustomer
-
-
-
- Use deleteCustomerAddressV2 instead.
-
-
-
Description
- Delete the billing or shipping address of a customer.
+ Delete customer account
@@ -13002,54 +12596,30 @@ Response
deleteCustomer
deleteCustomerAddressV2 instead. Description
-Delete the billing or shipping address of a customer.
+Delete customer account
Returns a Boolean
Arguments
-| Name | -Description | -
|---|---|
- id - Int!
- |
- The ID of the customer address to be deleted. | -
Example
Query
-mutation deleteCustomerAddress($id: Int!) {
- deleteCustomerAddress(id: $id)
+ mutation deleteCustomer {
+ deleteCustomer
}
-
- Variables
-{"id": 123}
Response
-{"data": {"deleteCustomerAddress": true}}
+ {"data": {"deleteCustomer": false}}
- deleteCustomerAddressV2
+ deleteCustomerAddress
Arguments
uid - ID!
+ id - Int!
Arguments
Example
Query
-mutation deleteCustomerAddressV2($uid: ID!) {
- deleteCustomerAddressV2(uid: $uid)
+ mutation deleteCustomerAddress($id: Int!) {
+ deleteCustomerAddress(id: $id)
}
Variables
-{"uid": 4}
+ {"id": 987}
Response
-{"data": {"deleteCustomerAddressV2": true}}
+ {"data": {"deleteCustomerAddress": true}}
Query
Variables
-{"requisitionListUid": "4"}
+ {"requisitionListUid": 4}
Query
Variables
{
- "requisitionListUid": "4",
- "requisitionListItemUids": [4]
+ "requisitionListUid": 4,
+ "requisitionListItemUids": ["4"]
}
Response
"estimateShippingMethods": [ { "amount": Money, - "available": false, + "available": true, "base_amount": Money, - "carrier_code": "abc123", + "carrier_code": "xyz789", "carrier_title": "xyz789", - "error_message": "xyz789", - "method_code": "xyz789", + "error_message": "abc123", + "method_code": "abc123", "method_title": "xyz789", "price_excl_tax": Money, "price_incl_tax": Money @@ -13886,82 +13456,6 @@Variables
Response
{"data": {"estimateTotals": {"cart": Cart}}}
-
-
- exchangeExternalCustomerToken
-
- Description
-Generate a token for specified customer.
-Response
- Returns an ExchangeExternalCustomerTokenOutput
-
Arguments
-| Name | -Description | -
|---|---|
- input - ExchangeExternalCustomerTokenInput
- |
- Contains details about external customer. | -
Example
-Query
-mutation exchangeExternalCustomerToken($input: ExchangeExternalCustomerTokenInput) {
- exchangeExternalCustomerToken(input: $input) {
- customer {
- ...CustomerFragment
- }
- token
- }
-}
-
- Variables
-{"input": ExchangeExternalCustomerTokenInput}
-
- Response
-{
- "data": {
- "exchangeExternalCustomerToken": {
- "customer": Customer,
- "token": "abc123"
- }
- }
-}
Query
Variables
{
- "email": "xyz789",
+ "email": "abc123",
"password": "xyz789"
}
@@ -14045,7 +13539,7 @@ Response
{
"data": {
"generateCustomerToken": {
- "token": "xyz789"
+ "token": "abc123"
}
}
}
@@ -14365,7 +13859,7 @@ Query
}
printed_card_included
rules {
- ...CartRuleStorefrontFragment
+ ...CartRuleFragment
}
selected_payment_method {
...SelectedPaymentMethodFragment
@@ -14382,7 +13876,7 @@ Query
Variables
{
"source_cart_id": "xyz789",
- "destination_cart_id": "abc123"
+ "destination_cart_id": "xyz789"
}
Response
"billing_address": BillingCartAddress, "email": "abc123", "gift_message": GiftMessage, - "gift_receipt_included": false, + "gift_receipt_included": true, "gift_wrapping": GiftWrapping, - "id": 4, - "is_virtual": false, + "id": "4", + "is_virtual": true, "items": [CartItemInterface], "itemsV2": CartItems, "prices": CartPrices, - "printed_card_included": false, - "rules": [CartRuleStorefront], + "printed_card_included": true, + "rules": [CartRule], "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], "total_quantity": 987.65 @@ -14496,7 +13990,7 @@Query
Variables
-{"cartUid": 4, "giftRegistryUid": 4}
+ {"cartUid": "4", "giftRegistryUid": 4}
Query
Variables
{
- "sourceRequisitionListUid": "4",
+ "sourceRequisitionListUid": 4,
"destinationRequisitionListUid": "4",
"requisitionListItem": MoveItemsBetweenRequisitionListsInput
}
@@ -14776,7 +14270,7 @@ Query
Variables
{
"sourceWishlistUid": "4",
- "destinationWishlistUid": 4,
+ "destinationWishlistUid": "4",
"wishlistItems": [WishlistItemMoveInput]
}
@@ -14894,13 +14388,13 @@ Response
"openNegotiableQuoteTemplate": {
"buyer": NegotiableQuoteUser,
"comments": [NegotiableQuoteComment],
- "expiration_date": "xyz789",
+ "expiration_date": "abc123",
"history": [NegotiableQuoteHistoryEntry],
"is_min_max_qty_used": false,
"is_virtual": true,
"items": [CartItemInterface],
- "max_order_commitment": 123,
- "min_order_commitment": 123,
+ "max_order_commitment": 987,
+ "min_order_commitment": 987,
"name": "xyz789",
"notifications": [QuoteTemplateNotificationMessage],
"prices": CartPrices,
@@ -14910,9 +14404,9 @@ Response
"shipping_addresses": [
NegotiableQuoteShippingAddress
],
- "status": "xyz789",
- "template_id": 4,
- "total_quantity": 123.45
+ "status": "abc123",
+ "template_id": "4",
+ "total_quantity": 987.65
}
}
}
@@ -15635,12 +15129,12 @@ Query
Variables
-{"giftRegistryUid": 4}
+ {"giftRegistryUid": "4"}
Response
-{"data": {"removeGiftRegistry": {"success": false}}}
+ {"data": {"removeGiftRegistry": {"success": true}}}
Query
Variables
{
"giftRegistryUid": "4",
- "registrantsUid": ["4"]
+ "registrantsUid": [4]
}
@@ -16060,12 +15554,12 @@ Response
"removeNegotiableQuoteTemplateItems": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "expiration_date": "abc123", + "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], "is_min_max_qty_used": false, "is_virtual": true, "items": [CartItemInterface], - "max_order_commitment": 987, + "max_order_commitment": 123, "min_order_commitment": 987, "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], @@ -16076,9 +15570,9 @@Response
"shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "abc123", + "status": "xyz789", "template_id": 4, - "total_quantity": 123.45 + "total_quantity": 987.65 } } } @@ -16158,9 +15652,9 @@Response
"data": { "removeProductsFromCompareList": { "attributes": [ComparableAttribute], - "item_count": 123, + "item_count": 987, "items": [ComparableItem], - "uid": 4 + "uid": "4" } } } @@ -16241,10 +15735,7 @@Query
Variables
-{
- "wishlistId": "4",
- "wishlistItemsIds": ["4"]
-}
+ {"wishlistId": 4, "wishlistItemsIds": [4]}
Query
Variables
-{"cartId": 4}
+ {"cartId": "4"}
Response
"comments": [NegotiableQuoteComment], "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], - "is_min_max_qty_used": true, + "is_min_max_qty_used": false, "is_virtual": false, "items": [CartItemInterface], - "max_order_commitment": 123, - "min_order_commitment": 987, + "max_order_commitment": 987, + "min_order_commitment": 123, "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, @@ -16954,9 +16445,9 @@Response
"shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "xyz789", + "status": "abc123", "template_id": "4", - "total_quantity": 987.65 + "total_quantity": 123.45 } } } @@ -17018,7 +16509,7 @@Query
Variables
-{"email": "xyz789"}
+ {"email": "abc123"}
Query
Variables
-{"email": "abc123"}
+ {"email": "xyz789"}
Response
-{"data": {"resendConfirmationEmail": true}}
+ {"data": {"resendConfirmationEmail": false}}
Query
Variables
{
"email": "xyz789",
- "resetPasswordToken": "abc123",
+ "resetPasswordToken": "xyz789",
"newPassword": "abc123"
}
@@ -17295,7 +16786,7 @@ Query
Response
-{"data": {"revokeCustomerToken": {"result": true}}}
+ {"data": {"revokeCustomerToken": {"result": false}}}
Variables
Response
{"data": {"setBillingAddressOnCart": {"cart": Cart}}}
-
-
- setCartAsInactive
-
- Description
-Sets the cart as inactive
-Response
- Returns a SetCartAsInactiveOutput
-
Arguments
-| Name | -Description | -
|---|---|
- cartId - String!
- |
- The customer cart ID | -
Example
-Query
-mutation setCartAsInactive($cartId: String!) {
- setCartAsInactive(cartId: $cartId) {
- error
- success
- }
-}
-
- Variables
-{"cartId": "abc123"}
-
- Response
-{
- "data": {
- "setCartAsInactive": {
- "error": "abc123",
- "success": false
- }
- }
-}
Response
"expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], "is_min_max_qty_used": true, - "is_virtual": true, + "is_virtual": false, "items": [CartItemInterface], "max_order_commitment": 123, "min_order_commitment": 987, @@ -18209,7 +17626,7 @@Response
NegotiableQuoteShippingAddress ], "status": "abc123", - "template_id": 4, + "template_id": "4", "total_quantity": 123.45 } } @@ -18474,14 +17891,14 @@Response
"setQuoteTemplateLineItemNote": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "expiration_date": "xyz789", + "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], "is_min_max_qty_used": true, - "is_virtual": true, + "is_virtual": false, "items": [CartItemInterface], "max_order_commitment": 123, "min_order_commitment": 123, - "name": "xyz789", + "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ @@ -18827,7 +18244,7 @@Response
"expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], "is_min_max_qty_used": false, - "is_virtual": false, + "is_virtual": true, "items": [CartItemInterface], "max_order_commitment": 123, "min_order_commitment": 987, @@ -18840,7 +18257,7 @@Response
"shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "abc123", + "status": "xyz789", "template_id": "4", "total_quantity": 123.45 } @@ -18975,7 +18392,71 @@Variables
Response
-{"data": {"syncPaymentOrder": false}}
+ {"data": {"syncPaymentOrder": true}}
+
+
+ trackViewedProduct
+
+ Description
+Track that a product was viewed in adobe commerce
+Response
+ Returns a Boolean
+
Arguments
+| Name | +Description | +
|---|---|
+ sku - String!
+ |
+ The sku for a ProductInterface object. |
+
Example
+Query
+mutation trackViewedProduct($sku: String!) {
+ trackViewedProduct(sku: $sku)
+}
+
+ Variables
+{"sku": "abc123"}
+
+ Response
+{"data": {"trackViewedProduct": true}}
Response
-
+
updateCustomerAddress
-
-
-
- Use updateCustomerAddressV2 instead.
-
-
-
@@ -19568,7 +19042,6 @@ Query
street
suffix
telephone
- uid
vat_id
}
}
@@ -19585,169 +19058,27 @@ Response
"data": {
"updateCustomerAddress": {
"city": "abc123",
- "company": "xyz789",
+ "company": "abc123",
"country_code": "AF",
"country_id": "xyz789",
"custom_attributes": [CustomerAddressAttribute],
"custom_attributesV2": [AttributeValueInterface],
"customer_id": 123,
- "default_billing": false,
- "default_shipping": false,
+ "default_billing": true,
+ "default_shipping": true,
"extension_attributes": [CustomerAddressAttribute],
- "fax": "abc123",
- "firstname": "abc123",
- "id": 123,
+ "fax": "xyz789",
+ "firstname": "xyz789",
+ "id": 987,
"lastname": "abc123",
"middlename": "xyz789",
- "postcode": "abc123",
+ "postcode": "xyz789",
"prefix": "abc123",
"region": CustomerAddressRegion,
"region_id": 987,
"street": ["abc123"],
"suffix": "xyz789",
- "telephone": "xyz789",
- "uid": "4",
- "vat_id": "abc123"
- }
- }
-}
-
-
-
-
-
-
-
- Mutations
-
-
- updateCustomerAddressV2
-
-
-
-
- Description
- Update the billing or shipping address of a customer or guest.
-
-
-
-
-
-
- Response
- Returns a CustomerAddress
-
-
-
- Arguments
-
-
-
- Name
- Description
-
-
-
-
-
- uid - ID!
-
- The unique ID of the customer address.
-
-
-
- input - CustomerAddressInput
-
- An input object that contains changes to the customer address.
-
-
-
-
-
-
- Example
-
- Query
- mutation updateCustomerAddressV2(
- $uid: ID!,
- $input: CustomerAddressInput
-) {
- updateCustomerAddressV2(
- uid: $uid,
- input: $input
- ) {
- city
- company
- country_code
- country_id
- custom_attributes {
- ...CustomerAddressAttributeFragment
- }
- custom_attributesV2 {
- ...AttributeValueInterfaceFragment
- }
- customer_id
- default_billing
- default_shipping
- extension_attributes {
- ...CustomerAddressAttributeFragment
- }
- fax
- firstname
- id
- lastname
- middlename
- postcode
- prefix
- region {
- ...CustomerAddressRegionFragment
- }
- region_id
- street
- suffix
- telephone
- uid
- vat_id
- }
-}
-
-
-
- Variables
- {
- "uid": "4",
- "input": CustomerAddressInput
-}
-
-
-
- Response
- {
- "data": {
- "updateCustomerAddressV2": {
- "city": "abc123",
- "company": "abc123",
- "country_code": "AF",
- "country_id": "abc123",
- "custom_attributes": [CustomerAddressAttribute],
- "custom_attributesV2": [AttributeValueInterface],
- "customer_id": 123,
- "default_billing": false,
- "default_shipping": false,
- "extension_attributes": [CustomerAddressAttribute],
- "fax": "abc123",
- "firstname": "xyz789",
- "id": 987,
- "lastname": "abc123",
- "middlename": "abc123",
- "postcode": "abc123",
- "prefix": "xyz789",
- "region": CustomerAddressRegion,
- "region_id": 123,
- "street": ["xyz789"],
- "suffix": "xyz789",
- "telephone": "xyz789",
- "uid": 4,
+ "telephone": "abc123",
"vat_id": "abc123"
}
}
@@ -19827,8 +19158,8 @@ Query
Variables
{
- "email": "abc123",
- "password": "xyz789"
+ "email": "xyz789",
+ "password": "abc123"
}
@@ -20394,7 +19725,7 @@ Query
Variables
{
- "wishlistId": "4",
+ "wishlistId": 4,
"wishlistItems": [WishlistItemUpdateInput]
}
@@ -20498,11 +19829,11 @@ Response
"condition": PurchaseOrderApprovalRuleConditionInterface,
"created_at": "abc123",
"created_by": "abc123",
- "description": "abc123",
- "name": "xyz789",
+ "description": "xyz789",
+ "name": "abc123",
"status": "ENABLED",
- "uid": 4,
- "updated_at": "abc123"
+ "uid": "4",
+ "updated_at": "xyz789"
}
}
}
@@ -20582,7 +19913,7 @@ Query
Variables
{
- "requisitionListUid": 4,
+ "requisitionListUid": "4",
"input": UpdateRequisitionListInput
}
@@ -20671,7 +20002,7 @@ Query
Variables
{
- "requisitionListUid": "4",
+ "requisitionListUid": 4,
"requisitionListItems": [
UpdateRequisitionListItemsInput
]
@@ -20770,8 +20101,8 @@ Query
Variables
{
- "wishlistId": "4",
- "name": "abc123",
+ "wishlistId": 4,
+ "name": "xyz789",
"visibility": "PUBLIC"
}
@@ -20781,7 +20112,7 @@ Response
{
"data": {
"updateWishlist": {
- "name": "abc123",
+ "name": "xyz789",
"uid": "4",
"visibility": "PUBLIC"
}
@@ -20903,7 +20234,7 @@ Fields
Example
- {"template_id": "4"}
+ {"template_id": 4}
@@ -20950,7 +20281,7 @@ Fields
Example
{
- "cart_id": "xyz789",
+ "cart_id": "abc123",
"cart_items": [BundleProductCartItemInput]
}
@@ -21122,7 +20453,7 @@ Fields
Example
{
- "cart_id": "abc123",
+ "cart_id": "xyz789",
"cart_items": [DownloadableProductCartItemInput]
}
@@ -21226,8 +20557,8 @@ Example
GiftRegistryDynamicAttributeInput
],
"email": "xyz789",
- "firstname": "abc123",
- "lastname": "xyz789"
+ "firstname": "xyz789",
+ "lastname": "abc123"
}
@@ -21360,57 +20691,7 @@ Fields
Example
- {
- "products": ["4"],
- "uid": "4"
-}
-
-
-
-
-
-
-
- Types
-
- AddProductsToNewCartOutput
-
-
-
- Description
- Contains details about the cart after adding products to it.
-
-
- Fields
-
-
-
- Field Name
- Description
-
-
-
-
- cart - Cart
-
- The cart after products have been added.
-
-
- user_errors - [CartUserInputError]
-
- Contains errors encountered while adding an item to the cart.
-
-
-
-
-
-
-
- Example
- {
- "cart": Cart,
- "user_errors": [CartUserInputError]
-}
+ {"products": [4], "uid": "4"}
@@ -21543,7 +20824,7 @@ Fields
Example
{
- "comment": "xyz789",
+ "comment": "abc123",
"purchase_order_uid": "4"
}
@@ -21637,9 +20918,9 @@ Fields
Example
{
- "cart_id": "xyz789",
+ "cart_id": "abc123",
"purchase_order_uid": "4",
- "replace_existing_cart_items": false
+ "replace_existing_cart_items": true
}
@@ -21846,10 +21127,7 @@ Fields
Example
- {
- "comment_text": "abc123",
- "return_uid": "4"
-}
+ {"comment_text": "abc123", "return_uid": 4}
@@ -21941,9 +21219,9 @@ Fields
Example
{
- "carrier_uid": 4,
- "return_uid": "4",
- "tracking_number": "abc123"
+ "carrier_uid": "4",
+ "return_uid": 4,
+ "tracking_number": "xyz789"
}
@@ -22126,7 +21404,7 @@ Fields
Example
{
- "cart_id": "abc123",
+ "cart_id": "xyz789",
"cart_items": [VirtualProductCartItemInput]
}
@@ -22409,7 +21687,7 @@ Example
{
"count": 987,
"label": "xyz789",
- "value": "xyz789"
+ "value": "abc123"
}
@@ -22562,7 +21840,7 @@ Fields
Example
{
"button_styles": ButtonStyles,
- "code": "xyz789",
+ "code": "abc123",
"is_visible": false,
"payment_intent": "xyz789",
"payment_source": "abc123",
@@ -22622,9 +21900,9 @@ Fields
Example
{
- "payment_source": "xyz789",
- "payments_order_id": "abc123",
- "paypal_order_id": "xyz789"
+ "payment_source": "abc123",
+ "payments_order_id": "xyz789",
+ "paypal_order_id": "abc123"
}
@@ -22720,9 +21998,9 @@ Fields
Example
{
"applied_balance": Money,
- "code": "xyz789",
+ "code": "abc123",
"current_balance": Money,
- "expiration_date": "xyz789"
+ "expiration_date": "abc123"
}
@@ -22775,7 +22053,7 @@ Example
{
"applied_balance": Money,
"current_balance": Money,
- "enabled": true
+ "enabled": false
}
@@ -22823,8 +22101,8 @@ Fields
Example
{
- "cart_id": "abc123",
- "coupon_code": "abc123"
+ "cart_id": "xyz789",
+ "coupon_code": "xyz789"
}
@@ -22966,7 +22244,7 @@ Fields
Example
{
"cart_id": "abc123",
- "coupon_codes": ["abc123"],
+ "coupon_codes": ["xyz789"],
"type": "APPEND"
}
@@ -23102,7 +22380,7 @@ Fields
Example
{
"applied_balance": Money,
- "code": "xyz789"
+ "code": "abc123"
}
@@ -23182,7 +22460,7 @@ Fields
Example
- {"cart_id": "xyz789"}
+ {"cart_id": "abc123"}
@@ -23267,7 +22545,7 @@ Fields
Example
- {"radius": 987, "search_term": "abc123"}
+ {"radius": 123, "search_term": "abc123"}
@@ -23558,18 +22836,18 @@ Fields
Example
{
- "is_comparable": true,
+ "is_comparable": false,
"is_filterable": false,
- "is_filterable_in_search": true,
- "is_html_allowed_on_front": true,
+ "is_filterable_in_search": false,
+ "is_html_allowed_on_front": false,
"is_searchable": false,
"is_used_for_customer_segment": true,
"is_used_for_price_rules": false,
- "is_used_for_promo_rules": true,
- "is_visible_in_advanced_search": false,
+ "is_used_for_promo_rules": false,
+ "is_visible_in_advanced_search": true,
"is_visible_on_front": true,
"is_wysiwyg_enabled": false,
- "used_in_product_listing": false
+ "used_in_product_listing": true
}
@@ -23764,7 +23042,7 @@ Fields
Example
{
"attribute_code": "xyz789",
- "entity_type": "xyz789"
+ "entity_type": "abc123"
}
@@ -23886,7 +23164,7 @@ Fields
Example
{
"code": 4,
- "default_value": "xyz789",
+ "default_value": "abc123",
"entity_type": "CATALOG_PRODUCT",
"frontend_class": "abc123",
"frontend_input": "BOOLEAN",
@@ -24044,7 +23322,7 @@ Fields
Example
{
- "label": "xyz789",
+ "label": "abc123",
"value": "xyz789"
}
@@ -24097,7 +23375,7 @@ Fields
Example
{
"is_default": true,
- "label": "xyz789",
+ "label": "abc123",
"value": "abc123"
}
@@ -24140,8 +23418,8 @@ Fields
Example
{
- "label": "xyz789",
- "value": "abc123"
+ "label": "abc123",
+ "value": "xyz789"
}
@@ -24200,8 +23478,8 @@ Possible Types
Example
{
- "label": "abc123",
- "value": "abc123"
+ "label": "xyz789",
+ "value": "xyz789"
}
@@ -24286,10 +23564,7 @@ Fields
Example
- {
- "code": "4",
- "value": "abc123"
-}
+ {"code": 4, "value": "abc123"}
@@ -24344,7 +23619,7 @@ Example
{
"attribute_code": "abc123",
"selected_options": [AttributeInputSelectedOption],
- "value": "abc123"
+ "value": "xyz789"
}
@@ -24395,11 +23670,6 @@ Possible Types
updateCustomerAddress
updateCustomerAddressV2 instead. Query
street suffix telephone - uid vat_id } } @@ -19585,169 +19058,27 @@Response
"data": { "updateCustomerAddress": { "city": "abc123", - "company": "xyz789", + "company": "abc123", "country_code": "AF", "country_id": "xyz789", "custom_attributes": [CustomerAddressAttribute], "custom_attributesV2": [AttributeValueInterface], "customer_id": 123, - "default_billing": false, - "default_shipping": false, + "default_billing": true, + "default_shipping": true, "extension_attributes": [CustomerAddressAttribute], - "fax": "abc123", - "firstname": "abc123", - "id": 123, + "fax": "xyz789", + "firstname": "xyz789", + "id": 987, "lastname": "abc123", "middlename": "xyz789", - "postcode": "abc123", + "postcode": "xyz789", "prefix": "abc123", "region": CustomerAddressRegion, "region_id": 987, "street": ["abc123"], "suffix": "xyz789", - "telephone": "xyz789", - "uid": "4", - "vat_id": "abc123" - } - } -} - -
- updateCustomerAddressV2
-
- Description
-Update the billing or shipping address of a customer or guest.
-Response
- Returns a CustomerAddress
-
Arguments
-| Name | -Description | -
|---|---|
- uid - ID!
- |
- The unique ID of the customer address. | -
- input - CustomerAddressInput
- |
- An input object that contains changes to the customer address. | -
Example
-Query
-mutation updateCustomerAddressV2(
- $uid: ID!,
- $input: CustomerAddressInput
-) {
- updateCustomerAddressV2(
- uid: $uid,
- input: $input
- ) {
- city
- company
- country_code
- country_id
- custom_attributes {
- ...CustomerAddressAttributeFragment
- }
- custom_attributesV2 {
- ...AttributeValueInterfaceFragment
- }
- customer_id
- default_billing
- default_shipping
- extension_attributes {
- ...CustomerAddressAttributeFragment
- }
- fax
- firstname
- id
- lastname
- middlename
- postcode
- prefix
- region {
- ...CustomerAddressRegionFragment
- }
- region_id
- street
- suffix
- telephone
- uid
- vat_id
- }
-}
-
- Variables
-{
- "uid": "4",
- "input": CustomerAddressInput
-}
-
- Response
-{
- "data": {
- "updateCustomerAddressV2": {
- "city": "abc123",
- "company": "abc123",
- "country_code": "AF",
- "country_id": "abc123",
- "custom_attributes": [CustomerAddressAttribute],
- "custom_attributesV2": [AttributeValueInterface],
- "customer_id": 123,
- "default_billing": false,
- "default_shipping": false,
- "extension_attributes": [CustomerAddressAttribute],
- "fax": "abc123",
- "firstname": "xyz789",
- "id": 987,
- "lastname": "abc123",
- "middlename": "abc123",
- "postcode": "abc123",
- "prefix": "xyz789",
- "region": CustomerAddressRegion,
- "region_id": 123,
- "street": ["xyz789"],
- "suffix": "xyz789",
- "telephone": "xyz789",
- "uid": 4,
+ "telephone": "abc123",
"vat_id": "abc123"
}
}
@@ -19827,8 +19158,8 @@ Query
Variables
{
- "email": "abc123",
- "password": "xyz789"
+ "email": "xyz789",
+ "password": "abc123"
}
@@ -20394,7 +19725,7 @@ Query
Variables
{
- "wishlistId": "4",
+ "wishlistId": 4,
"wishlistItems": [WishlistItemUpdateInput]
}
@@ -20498,11 +19829,11 @@ Response
"condition": PurchaseOrderApprovalRuleConditionInterface,
"created_at": "abc123",
"created_by": "abc123",
- "description": "abc123",
- "name": "xyz789",
+ "description": "xyz789",
+ "name": "abc123",
"status": "ENABLED",
- "uid": 4,
- "updated_at": "abc123"
+ "uid": "4",
+ "updated_at": "xyz789"
}
}
}
@@ -20582,7 +19913,7 @@ Query
Variables
{
- "requisitionListUid": 4,
+ "requisitionListUid": "4",
"input": UpdateRequisitionListInput
}
@@ -20671,7 +20002,7 @@ Query
Variables
{
- "requisitionListUid": "4",
+ "requisitionListUid": 4,
"requisitionListItems": [
UpdateRequisitionListItemsInput
]
@@ -20770,8 +20101,8 @@ Query
Variables
{
- "wishlistId": "4",
- "name": "abc123",
+ "wishlistId": 4,
+ "name": "xyz789",
"visibility": "PUBLIC"
}
@@ -20781,7 +20112,7 @@ Response
{
"data": {
"updateWishlist": {
- "name": "abc123",
+ "name": "xyz789",
"uid": "4",
"visibility": "PUBLIC"
}
@@ -20903,7 +20234,7 @@ Fields
Example
- {"template_id": "4"}
+ {"template_id": 4}
@@ -20950,7 +20281,7 @@ Fields
Example
{
- "cart_id": "xyz789",
+ "cart_id": "abc123",
"cart_items": [BundleProductCartItemInput]
}
@@ -21122,7 +20453,7 @@ Fields
Example
{
- "cart_id": "abc123",
+ "cart_id": "xyz789",
"cart_items": [DownloadableProductCartItemInput]
}
@@ -21226,8 +20557,8 @@ Example
GiftRegistryDynamicAttributeInput
],
"email": "xyz789",
- "firstname": "abc123",
- "lastname": "xyz789"
+ "firstname": "xyz789",
+ "lastname": "abc123"
}
@@ -21360,57 +20691,7 @@ Fields
Example
- {
- "products": ["4"],
- "uid": "4"
-}
-
-
-
-
-
-
-
- Types
-
- AddProductsToNewCartOutput
-
-
-
- Description
- Contains details about the cart after adding products to it.
-
-
- Fields
-
-
-
- Field Name
- Description
-
-
-
-
- cart - Cart
-
- The cart after products have been added.
-
-
- user_errors - [CartUserInputError]
-
- Contains errors encountered while adding an item to the cart.
-
-
-
-
-
-
-
- Example
- {
- "cart": Cart,
- "user_errors": [CartUserInputError]
-}
+ {"products": [4], "uid": "4"}
@@ -21543,7 +20824,7 @@ Fields
Example
{
- "comment": "xyz789",
+ "comment": "abc123",
"purchase_order_uid": "4"
}
@@ -21637,9 +20918,9 @@ Fields
Example
{
- "cart_id": "xyz789",
+ "cart_id": "abc123",
"purchase_order_uid": "4",
- "replace_existing_cart_items": false
+ "replace_existing_cart_items": true
}
@@ -21846,10 +21127,7 @@ Fields
Example
- {
- "comment_text": "abc123",
- "return_uid": "4"
-}
+ {"comment_text": "abc123", "return_uid": 4}
@@ -21941,9 +21219,9 @@ Fields
Example
{
- "carrier_uid": 4,
- "return_uid": "4",
- "tracking_number": "abc123"
+ "carrier_uid": "4",
+ "return_uid": 4,
+ "tracking_number": "xyz789"
}
@@ -22126,7 +21404,7 @@ Fields
Example
{
- "cart_id": "abc123",
+ "cart_id": "xyz789",
"cart_items": [VirtualProductCartItemInput]
}
@@ -22409,7 +21687,7 @@ Example
{
"count": 987,
"label": "xyz789",
- "value": "xyz789"
+ "value": "abc123"
}
@@ -22562,7 +21840,7 @@ Fields
Example
{
"button_styles": ButtonStyles,
- "code": "xyz789",
+ "code": "abc123",
"is_visible": false,
"payment_intent": "xyz789",
"payment_source": "abc123",
@@ -22622,9 +21900,9 @@ Fields
Example
{
- "payment_source": "xyz789",
- "payments_order_id": "abc123",
- "paypal_order_id": "xyz789"
+ "payment_source": "abc123",
+ "payments_order_id": "xyz789",
+ "paypal_order_id": "abc123"
}
@@ -22720,9 +21998,9 @@ Fields
Example
{
"applied_balance": Money,
- "code": "xyz789",
+ "code": "abc123",
"current_balance": Money,
- "expiration_date": "xyz789"
+ "expiration_date": "abc123"
}
@@ -22775,7 +22053,7 @@ Example
{
"applied_balance": Money,
"current_balance": Money,
- "enabled": true
+ "enabled": false
}
@@ -22823,8 +22101,8 @@ Fields
Example
{
- "cart_id": "abc123",
- "coupon_code": "abc123"
+ "cart_id": "xyz789",
+ "coupon_code": "xyz789"
}
@@ -22966,7 +22244,7 @@ Fields
Example
{
"cart_id": "abc123",
- "coupon_codes": ["abc123"],
+ "coupon_codes": ["xyz789"],
"type": "APPEND"
}
@@ -23102,7 +22380,7 @@ Fields
Example
{
"applied_balance": Money,
- "code": "xyz789"
+ "code": "abc123"
}
@@ -23182,7 +22460,7 @@ Fields
Example
- {"cart_id": "xyz789"}
+ {"cart_id": "abc123"}
@@ -23267,7 +22545,7 @@ Fields
Example
- {"radius": 987, "search_term": "abc123"}
+ {"radius": 123, "search_term": "abc123"}
@@ -23558,18 +22836,18 @@ Fields
Example
{
- "is_comparable": true,
+ "is_comparable": false,
"is_filterable": false,
- "is_filterable_in_search": true,
- "is_html_allowed_on_front": true,
+ "is_filterable_in_search": false,
+ "is_html_allowed_on_front": false,
"is_searchable": false,
"is_used_for_customer_segment": true,
"is_used_for_price_rules": false,
- "is_used_for_promo_rules": true,
- "is_visible_in_advanced_search": false,
+ "is_used_for_promo_rules": false,
+ "is_visible_in_advanced_search": true,
"is_visible_on_front": true,
"is_wysiwyg_enabled": false,
- "used_in_product_listing": false
+ "used_in_product_listing": true
}
@@ -23764,7 +23042,7 @@ Fields
Example
{
"attribute_code": "xyz789",
- "entity_type": "xyz789"
+ "entity_type": "abc123"
}
@@ -23886,7 +23164,7 @@ Fields
Example
{
"code": 4,
- "default_value": "xyz789",
+ "default_value": "abc123",
"entity_type": "CATALOG_PRODUCT",
"frontend_class": "abc123",
"frontend_input": "BOOLEAN",
@@ -24044,7 +23322,7 @@ Fields
Example
{
- "label": "xyz789",
+ "label": "abc123",
"value": "xyz789"
}
@@ -24097,7 +23375,7 @@ Fields
Example
{
"is_default": true,
- "label": "xyz789",
+ "label": "abc123",
"value": "abc123"
}
@@ -24140,8 +23418,8 @@ Fields
Example
{
- "label": "xyz789",
- "value": "abc123"
+ "label": "abc123",
+ "value": "xyz789"
}
@@ -24200,8 +23478,8 @@ Possible Types
Example
{
- "label": "abc123",
- "value": "abc123"
+ "label": "xyz789",
+ "value": "xyz789"
}
@@ -24286,10 +23564,7 @@ Fields
Example
- {
- "code": "4",
- "value": "abc123"
-}
+ {"code": 4, "value": "abc123"}
@@ -24344,7 +23619,7 @@ Example
{
"attribute_code": "abc123",
"selected_options": [AttributeInputSelectedOption],
- "value": "abc123"
+ "value": "xyz789"
}
@@ -24395,11 +23670,6 @@ Possible Types
Possible Types
Example
-{"code": 4}
+ {"code": "4"}
Fields
Example
-{"code": "AFN", "symbol": "abc123"}
+ {"code": "AFN", "symbol": "xyz789"}
Fields
Example
{
- "code": "abc123",
+ "code": "xyz789",
"is_deferred": false,
- "title": "abc123"
+ "title": "xyz789"
}
Fields
Example
{
"amount": Money,
- "available": false,
+ "available": true,
"base_amount": Money,
"carrier_code": "abc123",
- "carrier_title": "abc123",
- "error_message": "abc123",
+ "carrier_title": "xyz789",
+ "error_message": "xyz789",
"method_code": "abc123",
- "method_title": "abc123",
+ "method_title": "xyz789",
"price_excl_tax": Money,
"price_incl_tax": Money
}
@@ -24785,12 +24055,6 @@ Fields
An ID from the customer's address book that uniquely identifies the address to be used for billing.
-
-
- customer_address_uid - ID
-
- The unique ID from the customer's address book that uniquely identifies the address to be used for billing.
-
same_as_shipping - Boolean
@@ -24812,8 +24076,7 @@ Fields
Example
{
"address": CartAddressInput,
- "customer_address_id": 987,
- "customer_address_uid": 4,
+ "customer_address_id": 123,
"same_as_shipping": true,
"use_for_shipping": true
}
@@ -24887,12 +24150,12 @@ Fields
Example
{
- "address_line_1": "xyz789",
+ "address_line_1": "abc123",
"address_line_2": "abc123",
"city": "abc123",
- "country_code": "abc123",
+ "country_code": "xyz789",
"postal_code": "xyz789",
- "region": "xyz789"
+ "region": "abc123"
}
@@ -24940,11 +24203,6 @@ Fields
The custom attribute values of the billing or shipping address.
-
- customer_address_uid - ID
-
- The unique ID from the customer's address book that uniquely identifies the address.
-
customer_notes - String
@@ -24963,10 +24221,9 @@ Fields
The first name of the customer or guest.
- id - Int
-
- Id of the customer address. Use customer_address_uid instead.
+ id - Int
+ Id of the customer address.
lastname - String!
@@ -25009,9 +24266,9 @@ Fields
The telephone number for the billing or shipping address.
- uid - ID!
+ uid - String!
- The unique id of the customer cart address.
+ The unique id of the customer address.
vat_id - String
@@ -25026,25 +24283,24 @@ Fields
Example
{
- "city": "abc123",
+ "city": "xyz789",
"company": "abc123",
"country": CartAddressCountry,
"custom_attributes": [AttributeValueInterface],
- "customer_address_uid": 4,
"customer_notes": "abc123",
- "fax": "abc123",
+ "fax": "xyz789",
"firstname": "xyz789",
"id": 987,
- "lastname": "abc123",
- "middlename": "abc123",
- "postcode": "xyz789",
+ "lastname": "xyz789",
+ "middlename": "xyz789",
+ "postcode": "abc123",
"prefix": "abc123",
"region": CartAddressRegion,
- "street": ["xyz789"],
- "suffix": "abc123",
- "telephone": "abc123",
- "uid": 4,
- "vat_id": "xyz789"
+ "street": ["abc123"],
+ "suffix": "xyz789",
+ "telephone": "xyz789",
+ "uid": "xyz789",
+ "vat_id": "abc123"
}
@@ -25064,11 +24320,6 @@ Description
-
- Example
- true
-
-
@@ -25164,7 +24415,7 @@ Example
{
"device_data": "xyz789",
"is_active_payment_token_enabler": false,
- "payment_method_nonce": "abc123"
+ "payment_method_nonce": "xyz789"
}
@@ -25210,7 +24461,7 @@ Fields
Example
{
- "device_data": "xyz789",
+ "device_data": "abc123",
"public_hash": "xyz789"
}
@@ -25278,12 +24529,12 @@ Fields
Example
{
- "category_id": 123,
+ "category_id": 987,
"category_level": 123,
"category_name": "abc123",
- "category_uid": 4,
- "category_url_key": "xyz789",
- "category_url_path": "abc123"
+ "category_uid": "4",
+ "category_url_key": "abc123",
+ "category_url_path": "xyz789"
}
@@ -25418,7 +24669,7 @@ Example
"errors": [CartItemError],
"gift_message": GiftMessage,
"gift_wrapping": GiftWrapping,
- "id": "abc123",
+ "id": "xyz789",
"is_available": false,
"max_qty": 123.45,
"min_qty": 123.45,
@@ -25427,8 +24678,8 @@ Example
"note_from_seller": [ItemNote],
"prices": CartItemPrices,
"product": ProductInterface,
- "quantity": 987.65,
- "uid": 4
+ "quantity": 123.45,
+ "uid": "4"
}
@@ -25591,10 +24842,10 @@ Example
"discounts": [Discount],
"id": "4",
"order_item": OrderItemInterface,
- "product_name": "abc123",
+ "product_name": "xyz789",
"product_sale_price": Money,
"product_sku": "xyz789",
- "quantity_invoiced": 123.45
+ "quantity_invoiced": 987.65
}
@@ -25678,7 +24929,7 @@ Example
{
"option_id": 987,
"options": [BundleItemOption],
- "position": 987,
+ "position": 123,
"price_range": PriceRange,
"required": true,
"sku": "xyz789",
@@ -25777,16 +25028,16 @@ Fields
Example
{
- "can_change_quantity": false,
- "id": 987,
+ "can_change_quantity": true,
+ "id": 123,
"is_default": false,
- "label": "abc123",
+ "label": "xyz789",
"position": 123,
- "price": 987.65,
+ "price": 123.45,
"price_type": "FIXED",
"product": ProductInterface,
"qty": 987.65,
- "quantity": 987.65,
+ "quantity": 123.45,
"uid": "4"
}
@@ -25841,7 +25092,7 @@ Fields
Example
{
- "id": 987,
+ "id": 123,
"quantity": 123.45,
"value": ["abc123"]
}
@@ -26006,7 +25257,7 @@ Example
"gift_message": GiftMessage,
"gift_wrapping": GiftWrapping,
"id": 4,
- "parent_sku": "xyz789",
+ "parent_sku": "abc123",
"prices": OrderItemPrices,
"product": ProductInterface,
"product_name": "abc123",
@@ -26019,10 +25270,10 @@ Example
"quantity_ordered": 123.45,
"quantity_refunded": 987.65,
"quantity_return_requested": 987.65,
- "quantity_returned": 123.45,
- "quantity_shipped": 123.45,
+ "quantity_returned": 987.65,
+ "quantity_shipped": 987.65,
"selected_options": [OrderItemOption],
- "status": "abc123"
+ "status": "xyz789"
}
@@ -26418,6 +25669,11 @@ currentPage
+
+ rules - [CatalogRule]
+
+ Provides applied catalog rules in the current active cart
+
sale - Int
@@ -26605,49 +25861,49 @@ Example
{
"activity": "abc123",
"attribute_set_id": 987,
- "canonical_url": "xyz789",
+ "canonical_url": "abc123",
"categories": [CategoryInterface],
- "category_gear": "xyz789",
- "climate": "abc123",
- "collar": "xyz789",
- "color": 123,
+ "category_gear": "abc123",
+ "climate": "xyz789",
+ "collar": "abc123",
+ "color": 987,
"country_of_manufacture": "abc123",
- "created_at": "abc123",
+ "created_at": "xyz789",
"crosssell_products": [ProductInterface],
"custom_attributesV2": ProductCustomAttributes,
"description": ComplexTextValue,
"dynamic_price": false,
"dynamic_sku": true,
- "dynamic_weight": true,
- "eco_collection": 123,
- "erin_recommends": 987,
+ "dynamic_weight": false,
+ "eco_collection": 987,
+ "erin_recommends": 123,
"features_bags": "xyz789",
- "format": 123,
+ "format": 987,
"gender": "xyz789",
- "gift_message_available": false,
- "gift_wrapping_available": false,
+ "gift_message_available": true,
+ "gift_wrapping_available": true,
"gift_wrapping_price": Money,
- "id": 987,
+ "id": 123,
"image": ProductImage,
"is_returnable": "xyz789",
"items": [BundleItem],
- "manufacturer": 123,
+ "manufacturer": 987,
"material": "xyz789",
- "max_sale_qty": 123.45,
+ "max_sale_qty": 987.65,
"media_gallery": [MediaGalleryInterface],
"media_gallery_entries": [MediaGalleryEntry],
- "meta_description": "abc123",
- "meta_keyword": "abc123",
+ "meta_description": "xyz789",
+ "meta_keyword": "xyz789",
"meta_title": "abc123",
"min_sale_qty": 987.65,
- "name": "abc123",
+ "name": "xyz789",
"new": 123,
- "new_from_date": "abc123",
- "new_to_date": "xyz789",
- "only_x_left_in_stock": 987.65,
+ "new_from_date": "xyz789",
+ "new_to_date": "abc123",
+ "only_x_left_in_stock": 123.45,
"options": [CustomizableOptionInterface],
- "options_container": "xyz789",
- "pattern": "abc123",
+ "options_container": "abc123",
+ "pattern": "xyz789",
"performance_fabric": 987,
"price": ProductPrices,
"price_details": PriceDetails,
@@ -26655,33 +25911,34 @@ Example
"price_tiers": [TierPrice],
"price_view": "PRICE_RANGE",
"product_links": [ProductLinksInterface],
- "purpose": 123,
- "quantity": 123.45,
- "rating_summary": 123.45,
+ "purpose": 987,
+ "quantity": 987.65,
+ "rating_summary": 987.65,
"redirect_code": 987,
"related_products": [ProductInterface],
- "relative_url": "xyz789",
- "review_count": 987,
+ "relative_url": "abc123",
+ "review_count": 123,
"reviews": ProductReviews,
- "sale": 123,
+ "rules": [CatalogRule],
+ "sale": 987,
"ship_bundle_items": "TOGETHER",
"short_description": ComplexTextValue,
- "size": 123,
+ "size": 987,
"sku": "abc123",
"sleeve": "xyz789",
"small_image": ProductImage,
"special_from_date": "abc123",
- "special_price": 123.45,
+ "special_price": 987.65,
"special_to_date": "abc123",
"staged": true,
"stock_status": "IN_STOCK",
- "strap_bags": "abc123",
- "style_bags": "abc123",
+ "strap_bags": "xyz789",
+ "style_bags": "xyz789",
"style_bottom": "abc123",
- "style_general": "abc123",
- "swatch_image": "abc123",
+ "style_general": "xyz789",
+ "swatch_image": "xyz789",
"thumbnail": ProductImage,
- "tier_price": 123.45,
+ "tier_price": 987.65,
"tier_prices": [ProductTierPrices],
"type": "CMS_PAGE",
"type_id": "abc123",
@@ -26689,11 +25946,11 @@ Example
"updated_at": "abc123",
"upsell_products": [ProductInterface],
"url_key": "abc123",
- "url_path": "abc123",
+ "url_path": "xyz789",
"url_rewrites": [UrlRewrite],
- "url_suffix": "abc123",
+ "url_suffix": "xyz789",
"websites": [Website],
- "weight": 987.65
+ "weight": 123.45
}
@@ -26890,7 +26147,7 @@ Example
"order_item": OrderItemInterface,
"product_name": "xyz789",
"product_sale_price": Money,
- "product_sku": "xyz789",
+ "product_sku": "abc123",
"quantity_shipped": 987.65
}
@@ -26965,10 +26222,10 @@ Example
"added_at": "xyz789",
"bundle_options": [SelectedBundleOption],
"customizable_options": [SelectedCustomizableOption],
- "description": "xyz789",
- "id": "4",
+ "description": "abc123",
+ "id": 4,
"product": ProductInterface,
- "quantity": 123.45
+ "quantity": 987.65
}
@@ -27035,11 +26292,11 @@ Fields
Example
{
- "color": "xyz789",
+ "color": "abc123",
"height": 123,
"label": "xyz789",
- "layout": "abc123",
- "shape": "abc123",
+ "layout": "xyz789",
+ "shape": "xyz789",
"tagline": false,
"use_default_height": false
}
@@ -27089,8 +26346,8 @@ Fields
Example
{
- "cancellation_comment": "xyz789",
- "template_id": "4"
+ "cancellation_comment": "abc123",
+ "template_id": 4
}
@@ -27252,7 +26509,10 @@ Fields
Example
- {"order_id": 4, "reason": "abc123"}
+ {
+ "order_id": "4",
+ "reason": "xyz789"
+}
@@ -27438,7 +26698,7 @@ Fields
Example
- {"bin": "abc123"}
+ {"bin": "xyz789"}
@@ -27537,8 +26797,8 @@ Fields
Example
{
- "brand": "abc123",
- "expiry": "abc123",
+ "brand": "xyz789",
+ "expiry": "xyz789",
"last_digits": "abc123"
}
@@ -27683,7 +26943,7 @@ sort Indicates whether the shopper requested a printed card for the cart.
- rules - [CartRuleStorefront]
+ rules - [CartRule]
Provides applied cart rules in the current active cart
@@ -27718,7 +26978,7 @@ Example
"available_gift_wrappings": [GiftWrapping],
"available_payment_methods": [AvailablePaymentMethod],
"billing_address": BillingCartAddress,
- "email": "xyz789",
+ "email": "abc123",
"gift_message": GiftMessage,
"gift_receipt_included": true,
"gift_wrapping": GiftWrapping,
@@ -27727,11 +26987,11 @@ Example
"items": [CartItemInterface],
"itemsV2": CartItems,
"prices": CartPrices,
- "printed_card_included": true,
- "rules": [CartRuleStorefront],
+ "printed_card_included": false,
+ "rules": [CartRule],
"selected_payment_method": SelectedPaymentMethod,
"shipping_addresses": [ShippingCartAddress],
- "total_quantity": 123.45
+ "total_quantity": 987.65
}
@@ -27898,7 +27158,7 @@ Fields
telephone - String!
+ telephone - String
Fields
Example
{
- "city": "abc123",
+ "city": "xyz789",
"company": "abc123",
"country_code": "xyz789",
"custom_attributes": [AttributeValueInput],
"fax": "xyz789",
- "firstname": "xyz789",
+ "firstname": "abc123",
"lastname": "xyz789",
"middlename": "xyz789",
- "postcode": "xyz789",
- "prefix": "abc123",
- "region": "xyz789",
- "region_id": 123,
- "save_in_address_book": false,
+ "postcode": "abc123",
+ "prefix": "xyz789",
+ "region": "abc123",
+ "region_id": 987,
+ "save_in_address_book": true,
"street": ["abc123"],
"suffix": "xyz789",
- "telephone": "abc123",
- "vat_id": "abc123"
+ "telephone": "xyz789",
+ "vat_id": "xyz789"
}
Fields
customer_address_uid - ID
- fax - String
Fields
id - Int
- customer_address_uid instead.
+ id - Int
lastname - String!
@@ -28038,9 +27292,9 @@ Fields
uid - ID!
+ uid - String!
vat_id - String
@@ -28078,23 +27332,22 @@ Possible Types
Example
{
"city": "abc123",
- "company": "abc123",
+ "company": "xyz789",
"country": CartAddressCountry,
"custom_attributes": [AttributeValueInterface],
- "customer_address_uid": 4,
- "fax": "xyz789",
+ "fax": "abc123",
"firstname": "xyz789",
- "id": 123,
- "lastname": "xyz789",
+ "id": 987,
+ "lastname": "abc123",
"middlename": "abc123",
"postcode": "abc123",
- "prefix": "abc123",
+ "prefix": "xyz789",
"region": CartAddressRegion,
- "street": ["abc123"],
+ "street": ["xyz789"],
"suffix": "abc123",
- "telephone": "xyz789",
- "uid": "4",
- "vat_id": "xyz789"
+ "telephone": "abc123",
+ "uid": "xyz789",
+ "vat_id": "abc123"
}
@@ -28145,9 +27398,9 @@ Fields
Example
{
- "code": "xyz789",
- "label": "abc123",
- "region_id": 987
+ "code": "abc123",
+ "label": "xyz789",
+ "region_id": 123
}
Fields
Example
-{"code": "UNDEFINED", "message": "abc123"}
+ {"code": "UNDEFINED", "message": "xyz789"}
Fields
Example
{
"entered_options": [EnteredOptionInput],
- "parent_sku": "abc123",
- "quantity": 987.65,
+ "parent_sku": "xyz789",
+ "quantity": 123.45,
"selected_options": [4],
- "sku": "xyz789"
+ "sku": "abc123"
}
@@ -28523,12 +27776,12 @@ Possible Types
Example
{
"discount": [Discount],
"errors": [CartItemError],
- "id": "xyz789",
+ "id": "abc123",
"is_available": false,
"max_qty": 123.45,
"min_qty": 987.65,
- "not_available_message": "abc123",
+ "not_available_message": "xyz789",
"note_from_buyer": [ItemNote],
"note_from_seller": [ItemNote],
"prices": CartItemPrices,
@@ -28706,7 +27959,7 @@ Fields
Example
- {"cart_item_id": 987, "quantity": 987.65}
+ {"cart_item_id": 123, "quantity": 987.65}
@@ -28830,12 +28083,12 @@ Fields
Example
{
- "cart_item_id": 987,
+ "cart_item_id": 123,
"cart_item_uid": "4",
"customizable_options": [CustomizableOptionInput],
"gift_message": GiftMessageInput,
- "gift_wrapping_id": 4,
- "quantity": 123.45
+ "gift_wrapping_id": "4",
+ "quantity": 987.65
}
@@ -28982,11 +28235,11 @@ Example
-
+
- CartRuleStorefront
+ CartRule
@@ -29000,9 +28253,9 @@ Fields
- uid - ID!
+ name - String!
- The unique ID for a CartRule object.
+ Name of the cart price rule
@@ -29011,7 +28264,7 @@ Fields
Example
- {"uid": "4"}
+ {"name": "abc123"}
@@ -29057,7 +28310,7 @@ Fields
Example
{
"amount": Money,
- "label": "xyz789"
+ "label": "abc123"
}
@@ -29100,7 +28353,7 @@ Fields
Example
{
"code": "PRODUCT_NOT_FOUND",
- "message": "abc123"
+ "message": "xyz789"
}
@@ -29422,19 +28675,19 @@ Fields
Example
{
"apply_to": ["SIMPLE"],
- "code": "4",
- "default_value": "abc123",
+ "code": 4,
+ "default_value": "xyz789",
"entity_type": "CATALOG_PRODUCT",
"frontend_class": "abc123",
"frontend_input": "BOOLEAN",
- "is_comparable": false,
+ "is_comparable": true,
"is_filterable": true,
"is_filterable_in_search": false,
"is_html_allowed_on_front": false,
- "is_required": false,
- "is_searchable": true,
+ "is_required": true,
+ "is_searchable": false,
"is_unique": true,
- "is_used_for_price_rules": true,
+ "is_used_for_price_rules": false,
"is_used_for_promo_rules": true,
"is_visible_in_advanced_search": false,
"is_visible_on_front": false,
@@ -29443,9 +28696,44 @@ Example
"options": [CustomAttributeOptionInterface],
"swatch_input_type": "BOOLEAN",
"update_product_preview_image": true,
- "use_product_image_for_swatch": false,
+ "use_product_image_for_swatch": true,
"used_in_product_listing": true
}
+
+
+
+
+
+
+
+ Types
+
+ CatalogRule
+
+
+
+ Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+ name - String!
+
+ Name of the catalog rule
+
+
+
+
+
+
+
+ Example
+ {"name": "xyz789"}
@@ -29787,37 +29075,37 @@ Possible Types
Example
{
"automatic_sorting": "xyz789",
- "available_sort_by": ["xyz789"],
+ "available_sort_by": ["abc123"],
"breadcrumbs": [Breadcrumb],
- "canonical_url": "xyz789",
- "children_count": "xyz789",
+ "canonical_url": "abc123",
+ "children_count": "abc123",
"cms_block": CmsBlock,
- "created_at": "abc123",
+ "created_at": "xyz789",
"custom_layout_update_file": "abc123",
- "default_sort_by": "abc123",
+ "default_sort_by": "xyz789",
"description": "xyz789",
- "display_mode": "abc123",
- "filter_price_range": 123.45,
+ "display_mode": "xyz789",
+ "filter_price_range": 987.65,
"id": 123,
- "image": "xyz789",
+ "image": "abc123",
"include_in_menu": 987,
"is_anchor": 123,
"landing_page": 987,
- "level": 987,
+ "level": 123,
"meta_description": "abc123",
- "meta_keywords": "abc123",
+ "meta_keywords": "xyz789",
"meta_title": "xyz789",
- "name": "abc123",
- "path": "abc123",
+ "name": "xyz789",
+ "path": "xyz789",
"path_in_store": "abc123",
- "position": 123,
+ "position": 987,
"product_count": 123,
"products": CategoryProducts,
- "staged": false,
+ "staged": true,
"uid": 4,
- "updated_at": "abc123",
- "url_key": "abc123",
- "url_path": "xyz789",
+ "updated_at": "xyz789",
+ "url_key": "xyz789",
+ "url_path": "abc123",
"url_suffix": "abc123"
}
@@ -29871,7 +29159,7 @@ Example
{
"items": [ProductInterface],
"page_info": SearchResultPageInfo,
- "total_count": 987
+ "total_count": 123
}
@@ -29924,7 +29212,7 @@ Example
{
"items": [CategoryTree],
"page_info": SearchResultPageInfo,
- "total_count": 987
+ "total_count": 123
}
@@ -30188,40 +29476,40 @@ Example
"automatic_sorting": "xyz789",
"available_sort_by": ["abc123"],
"breadcrumbs": [Breadcrumb],
- "canonical_url": "xyz789",
+ "canonical_url": "abc123",
"children": [CategoryTree],
- "children_count": "abc123",
+ "children_count": "xyz789",
"cms_block": CmsBlock,
"created_at": "abc123",
- "custom_layout_update_file": "xyz789",
- "default_sort_by": "abc123",
+ "custom_layout_update_file": "abc123",
+ "default_sort_by": "xyz789",
"description": "xyz789",
- "display_mode": "xyz789",
+ "display_mode": "abc123",
"filter_price_range": 123.45,
"id": 123,
"image": "abc123",
- "include_in_menu": 123,
+ "include_in_menu": 987,
"is_anchor": 123,
"landing_page": 123,
- "level": 987,
- "meta_description": "abc123",
- "meta_keywords": "abc123",
- "meta_title": "abc123",
- "name": "abc123",
+ "level": 123,
+ "meta_description": "xyz789",
+ "meta_keywords": "xyz789",
+ "meta_title": "xyz789",
+ "name": "xyz789",
"path": "abc123",
"path_in_store": "abc123",
"position": 987,
"product_count": 123,
"products": CategoryProducts,
"redirect_code": 123,
- "relative_url": "abc123",
+ "relative_url": "xyz789",
"staged": false,
"type": "CMS_PAGE",
"uid": "4",
- "updated_at": "abc123",
- "url_key": "xyz789",
+ "updated_at": "xyz789",
+ "url_key": "abc123",
"url_path": "xyz789",
- "url_suffix": "abc123"
+ "url_suffix": "xyz789"
}
@@ -30292,13 +29580,13 @@ Fields
Example
{
- "agreement_id": 123,
- "checkbox_text": "xyz789",
+ "agreement_id": 987,
+ "checkbox_text": "abc123",
"content": "xyz789",
- "content_height": "xyz789",
- "is_html": false,
+ "content_height": "abc123",
+ "is_html": true,
"mode": "AUTO",
- "name": "abc123"
+ "name": "xyz789"
}
Fields
Example
{
"code": "REORDER_NOT_AVAILABLE",
- "message": "abc123",
+ "message": "xyz789",
"path": ["abc123"]
}
@@ -30605,7 +29893,7 @@ Fields
Example
-{"uid": "4"}
+ {"uid": 4}
Fields
Example
-{"cart": Cart, "status": false}
+ {"cart": Cart, "status": true}
Fields
Example
-{"quote_uids": [4]}
+ {"quote_uids": ["4"]}
Fields
Example
{
- "content": "xyz789",
+ "content": "abc123",
"identifier": "xyz789",
- "title": "xyz789"
+ "title": "abc123"
}
Fields
Example
{
"content": "abc123",
- "content_heading": "xyz789",
- "identifier": "xyz789",
- "meta_description": "xyz789",
- "meta_keywords": "xyz789",
+ "content_heading": "abc123",
+ "identifier": "abc123",
+ "meta_description": "abc123",
+ "meta_keywords": "abc123",
"meta_title": "xyz789",
- "page_layout": "abc123",
+ "page_layout": "xyz789",
"redirect_code": 987,
- "relative_url": "xyz789",
+ "relative_url": "abc123",
"title": "abc123",
"type": "CMS_PAGE",
- "url_key": "abc123"
+ "url_key": "xyz789"
}
@@ -31191,7 +30479,7 @@ Fields
Example
-{"value": "xyz789"}
+ {"value": "abc123"}
Example
"credit": CompanyCredit, "credit_history": CompanyCreditHistory, "email": "xyz789", - "id": 4, + "id": "4", "legal_address": CompanyLegalAddress, "legal_name": "abc123", - "name": "xyz789", + "name": "abc123", "payment_methods": ["xyz789"], "reseller_id": "xyz789", "role": CompanyRole, @@ -31605,7 +30893,7 @@Example
{
"children": [CompanyAclResource],
"id": 4,
- "sort_order": 123,
+ "sort_order": 987,
"text": "xyz789"
}
@@ -31685,12 +30973,12 @@ Fields
Example
{
"custom_attributes": [AttributeValueInput],
- "email": "xyz789",
- "firstname": "abc123",
- "gender": 123,
+ "email": "abc123",
+ "firstname": "xyz789",
+ "gender": 987,
"job_title": "abc123",
"lastname": "xyz789",
- "telephone": "abc123"
+ "telephone": "xyz789"
}
@@ -31741,9 +31029,9 @@ Fields
Example
{
- "id": "4",
+ "id": 4,
"legal_name": "xyz789",
- "name": "xyz789"
+ "name": "abc123"
}
Example
"company_email": "xyz789", "company_name": "abc123", "legal_address": CompanyLegalAddressCreateInput, - "legal_name": "abc123", + "legal_name": "xyz789", "reseller_id": "xyz789", - "vat_tax_id": "abc123" + "vat_tax_id": "xyz789" } @@ -31989,7 +31277,7 @@Example
{
"custom_reference_number": "abc123",
"operation_type": "ALLOCATION",
- "updated_by": "abc123"
+ "updated_by": "xyz789"
}
@@ -32058,7 +31346,7 @@ Example
"amount": Money, "balance": CompanyCredit, "custom_reference_number": "xyz789", - "date": "xyz789", + "date": "abc123", "type": "ALLOCATION", "updated_by": CompanyCreditOperationUser } @@ -32177,7 +31465,7 @@Fields
Example
-{"name": "xyz789", "type": "CUSTOMER"}
+ {"name": "abc123", "type": "CUSTOMER"}
Fields
Example
{
"code": "abc123",
- "role_id": 4,
+ "role_id": "4",
"user": CompanyInvitationUserInput
}
@@ -32383,7 +31671,7 @@ Example
{
"company_id": 4,
"customer_id": 4,
- "job_title": "abc123",
+ "job_title": "xyz789",
"status": "ACTIVE",
"telephone": "xyz789"
}
@@ -32451,9 +31739,9 @@ Fields
Example
{
- "city": "xyz789",
+ "city": "abc123",
"country_code": "AF",
- "postcode": "xyz789",
+ "postcode": "abc123",
"region": CustomerAddressRegion,
"street": ["abc123"],
"telephone": "abc123"
@@ -32528,12 +31816,12 @@ Fields
Example
{
- "city": "abc123",
+ "city": "xyz789",
"country_id": "AF",
- "postcode": "abc123",
+ "postcode": "xyz789",
"region": CustomerAddressRegionInput,
- "street": ["abc123"],
- "telephone": "abc123"
+ "street": ["xyz789"],
+ "telephone": "xyz789"
}
@@ -32609,7 +31897,7 @@ Example
"country_id": "AF",
"postcode": "abc123",
"region": CustomerAddressRegionInput,
- "street": ["xyz789"],
+ "street": ["abc123"],
"telephone": "xyz789"
}
@@ -32717,8 +32005,8 @@ Fields
Example
{
- "name": "xyz789",
- "permissions": ["abc123"]
+ "name": "abc123",
+ "permissions": ["xyz789"]
}
@@ -32773,8 +32061,8 @@ Fields
Example
{
"id": 4,
- "name": "abc123",
- "permissions": ["abc123"]
+ "name": "xyz789",
+ "permissions": ["xyz789"]
}
@@ -32878,9 +32166,9 @@ Fields
Example
{
- "email": "xyz789",
- "firstname": "abc123",
- "lastname": "abc123"
+ "email": "abc123",
+ "firstname": "xyz789",
+ "lastname": "xyz789"
}
@@ -33008,7 +32296,11 @@ Fields
Example
- {"entity": CompanyTeam, "id": 4, "parent_id": 4}
+ {
+ "entity": CompanyTeam,
+ "id": 4,
+ "parent_id": "4"
+}
@@ -33054,7 +32346,7 @@ Fields
Example
- {"parent_tree_id": 4, "tree_id": "4"}
+ {"parent_tree_id": 4, "tree_id": 4}
@@ -33087,7 +32379,7 @@ Fields
An optional description of the team.
id - ID
+ id - ID!
CompanyTeam object. Fields
Example
{
- "description": "abc123",
- "id": "4",
+ "description": "xyz789",
+ "id": 4,
"name": "xyz789",
- "structure_id": "4"
+ "structure_id": 4
}
Fields
Example
{
- "description": "abc123",
- "id": "4",
- "name": "xyz789"
+ "description": "xyz789",
+ "id": 4,
+ "name": "abc123"
}
Fields
Example
{
"company_email": "xyz789",
- "company_name": "xyz789",
+ "company_name": "abc123",
"legal_address": CompanyLegalAddressUpdateInput,
"legal_name": "xyz789",
- "reseller_id": "abc123",
- "vat_tax_id": "xyz789"
+ "reseller_id": "xyz789",
+ "vat_tax_id": "abc123"
}
@@ -33386,13 +32678,13 @@ Fields
Example
{
"email": "abc123",
- "firstname": "abc123",
+ "firstname": "xyz789",
"job_title": "abc123",
"lastname": "xyz789",
"role_id": "4",
"status": "ACTIVE",
"target_id": "4",
- "telephone": "xyz789"
+ "telephone": "abc123"
}
@@ -33522,10 +32814,10 @@ Fields
Example
{
- "email": "xyz789",
+ "email": "abc123",
"firstname": "abc123",
"id": 4,
- "job_title": "xyz789",
+ "job_title": "abc123",
"lastname": "xyz789",
"role_id": "4",
"status": "ACTIVE",
@@ -33722,7 +33014,7 @@ Example
{
"attributes": [ProductAttribute],
"product": ProductInterface,
- "uid": "4"
+ "uid": 4
}
Fields
Example
{
"attributes": [ComparableAttribute],
- "item_count": 987,
+ "item_count": 123,
"items": [ComparableItem],
"uid": "4"
}
-
-
-
-
- CompleteOrderInput
-Description
-Update the quote and complete the order
-Example
-{
- "cartId": "xyz789",
- "id": "xyz789"
-}
Fields
Example
{
- "code": "abc123",
+ "code": "xyz789",
"label": "abc123",
"uid": "4",
- "value_index": 987
+ "value_index": 123
}
Example
"gift_message": GiftMessage, "gift_wrapping": GiftWrapping, "id": "xyz789", - "is_available": true, + "is_available": false, "max_qty": 987.65, - "min_qty": 987.65, + "min_qty": 123.45, "not_available_message": "abc123", "note_from_buyer": [ItemNote], "note_from_seller": [ItemNote], "prices": CartItemPrices, "product": ProductInterface, - "quantity": 987.65, - "uid": 4 + "quantity": 123.45, + "uid": "4" }Fields
Example
{
"discounts": [Discount],
- "eligible_for_return": true,
+ "eligible_for_return": false,
"entered_options": [OrderItemOption],
"gift_message": GiftMessage,
"gift_wrapping": GiftWrapping,
- "id": "4",
+ "id": 4,
"parent_sku": "xyz789",
"prices": OrderItemPrices,
"product": ProductInterface,
"product_name": "xyz789",
"product_sale_price": Money,
"product_sku": "xyz789",
- "product_type": "xyz789",
- "product_url_key": "xyz789",
- "quantity_canceled": 987.65,
+ "product_type": "abc123",
+ "product_url_key": "abc123",
+ "quantity_canceled": 123.45,
"quantity_invoiced": 987.65,
- "quantity_ordered": 987.65,
- "quantity_refunded": 987.65,
- "quantity_return_requested": 987.65,
- "quantity_returned": 987.65,
- "quantity_shipped": 123.45,
+ "quantity_ordered": 123.45,
+ "quantity_refunded": 123.45,
+ "quantity_return_requested": 123.45,
+ "quantity_returned": 123.45,
+ "quantity_shipped": 987.65,
"selected_options": [OrderItemOption],
- "status": "xyz789"
+ "status": "abc123"
}
@@ -34680,6 +33923,11 @@ currentPage
+
+ rules - [CatalogRule]
+
+ Provides applied catalog rules in the current active cart
+
sale - Int
@@ -34866,12 +34114,12 @@ currentPageExample
{
"activity": "xyz789",
- "attribute_set_id": 987,
- "canonical_url": "xyz789",
+ "attribute_set_id": 123,
+ "canonical_url": "abc123",
"categories": [CategoryInterface],
- "category_gear": "abc123",
- "climate": "xyz789",
- "collar": "xyz789",
+ "category_gear": "xyz789",
+ "climate": "abc123",
+ "collar": "abc123",
"color": 123,
"configurable_options": [ConfigurableProductOptions],
"configurable_product_options_selection": ConfigurableProductOptionsSelection,
@@ -34881,74 +34129,75 @@ Example
"custom_attributesV2": ProductCustomAttributes,
"description": ComplexTextValue,
"eco_collection": 987,
- "erin_recommends": 123,
+ "erin_recommends": 987,
"features_bags": "xyz789",
- "format": 123,
+ "format": 987,
"gender": "xyz789",
- "gift_message_available": true,
- "gift_wrapping_available": true,
+ "gift_message_available": false,
+ "gift_wrapping_available": false,
"gift_wrapping_price": Money,
"id": 123,
"image": ProductImage,
"is_returnable": "xyz789",
- "manufacturer": 987,
- "material": "xyz789",
- "max_sale_qty": 123.45,
+ "manufacturer": 123,
+ "material": "abc123",
+ "max_sale_qty": 987.65,
"media_gallery": [MediaGalleryInterface],
"media_gallery_entries": [MediaGalleryEntry],
"meta_description": "abc123",
- "meta_keyword": "abc123",
+ "meta_keyword": "xyz789",
"meta_title": "xyz789",
"min_sale_qty": 123.45,
- "name": "xyz789",
- "new": 123,
+ "name": "abc123",
+ "new": 987,
"new_from_date": "abc123",
"new_to_date": "abc123",
- "only_x_left_in_stock": 987.65,
+ "only_x_left_in_stock": 123.45,
"options": [CustomizableOptionInterface],
- "options_container": "xyz789",
+ "options_container": "abc123",
"pattern": "xyz789",
- "performance_fabric": 123,
+ "performance_fabric": 987,
"price": ProductPrices,
"price_range": PriceRange,
"price_tiers": [TierPrice],
"product_links": [ProductLinksInterface],
- "purpose": 987,
- "quantity": 123.45,
+ "purpose": 123,
+ "quantity": 987.65,
"rating_summary": 123.45,
- "redirect_code": 123,
+ "redirect_code": 987,
"related_products": [ProductInterface],
"relative_url": "xyz789",
- "review_count": 123,
+ "review_count": 987,
"reviews": ProductReviews,
- "sale": 123,
+ "rules": [CatalogRule],
+ "sale": 987,
"short_description": ComplexTextValue,
"size": 123,
"sku": "xyz789",
- "sleeve": "abc123",
+ "sleeve": "xyz789",
"small_image": ProductImage,
- "special_from_date": "xyz789",
- "special_price": 123.45,
+ "special_from_date": "abc123",
+ "special_price": 987.65,
"special_to_date": "xyz789",
"staged": true,
"stock_status": "IN_STOCK",
- "strap_bags": "xyz789",
- "style_bags": "abc123",
- "style_bottom": "xyz789",
- "style_general": "xyz789",
+ "strap_bags": "abc123",
+ "style_bags": "xyz789",
+ "style_bottom": "abc123",
+ "style_general": "abc123",
"swatch_image": "abc123",
"thumbnail": ProductImage,
"tier_price": 987.65,
"tier_prices": [ProductTierPrices],
"type": "CMS_PAGE",
"type_id": "xyz789",
- "uid": 4,
- "updated_at": "abc123",
+ "uid": "4",
+ "updated_at": "xyz789",
"upsell_products": [ProductInterface],
"url_key": "abc123",
- "url_path": "xyz789",
+ "url_path": "abc123",
"url_rewrites": [UrlRewrite],
- "url_suffix": "xyz789",
+ "url_suffix": "abc123",
"variants": [ConfigurableVariant],
"websites": [Website],
"weight": 987.65
@@ -35010,7 +34259,7 @@ Example
{
"customizable_options": [CustomizableOptionInput],
"data": CartItemInput,
- "parent_sku": "xyz789",
+ "parent_sku": "abc123",
"variant_sku": "abc123"
}
@@ -35068,8 +34317,8 @@ Fields
Example
{
"attribute_code": "abc123",
- "label": "xyz789",
- "uid": 4,
+ "label": "abc123",
+ "uid": "4",
"values": [ConfigurableProductOptionValue]
}
@@ -35133,9 +34382,9 @@ Example
{
"is_available": false,
"is_use_default": true,
- "label": "xyz789",
+ "label": "abc123",
"swatch": SwatchDataInterface,
- "uid": 4
+ "uid": "4"
}
@@ -35232,14 +34481,14 @@ Example
{
"attribute_code": "abc123",
"attribute_id": "xyz789",
- "attribute_id_v2": 123,
+ "attribute_id_v2": 987,
"attribute_uid": "4",
- "id": 123,
+ "id": 987,
"label": "abc123",
- "position": 987,
- "product_id": 123,
+ "position": 123,
+ "product_id": 987,
"uid": 4,
- "use_default": false,
+ "use_default": true,
"values": [ConfigurableProductOptionsValues]
}
@@ -35373,13 +34622,13 @@ Fields
Example
{
- "default_label": "abc123",
- "label": "xyz789",
+ "default_label": "xyz789",
+ "label": "abc123",
"store_label": "abc123",
"swatch_data": SwatchDataInterface,
"uid": "4",
- "use_default_value": true,
- "value_index": 123
+ "use_default_value": false,
+ "value_index": 987
}
@@ -35443,7 +34692,7 @@ Example
"configurable_options": [SelectedConfigurableOption],
"customizable_options": [SelectedCustomizableOption],
"product": ProductInterface,
- "quantity": 987.65,
+ "quantity": 123.45,
"uid": 4
}
@@ -35581,7 +34830,7 @@ Example
"description": "xyz789",
"id": "4",
"product": ProductInterface,
- "quantity": 987.65
+ "quantity": 123.45
}
@@ -35626,7 +34875,7 @@ Fields
Example
{
"confirmation_key": "xyz789",
- "order_id": "4"
+ "order_id": 4
}
@@ -35674,7 +34923,7 @@ Fields
Example
{
- "confirmation_key": "xyz789",
+ "confirmation_key": "abc123",
"email": "xyz789"
}
@@ -35719,8 +34968,8 @@ Fields
Example
{
- "confirmation_key": "abc123",
- "order_id": 4
+ "confirmation_key": "xyz789",
+ "order_id": "4"
}
@@ -35822,10 +35071,10 @@ Fields
Example
{
- "comment": "xyz789",
+ "comment": "abc123",
"email": "abc123",
- "name": "xyz789",
- "telephone": "abc123"
+ "name": "abc123",
+ "telephone": "xyz789"
}
@@ -35865,7 +35114,7 @@ Fields
Example
- {"status": true}
+ {"status": false}
@@ -35905,7 +35154,7 @@ Fields
Example
- {"requisitionListItemUids": ["4"]}
+ {"requisitionListItemUids": [4]}
@@ -36059,10 +35308,10 @@ Fields
Example
{
"available_regions": [Region],
- "full_name_english": "xyz789",
- "full_name_locale": "abc123",
+ "full_name_english": "abc123",
+ "full_name_locale": "xyz789",
"id": "xyz789",
- "three_letter_abbreviation": "xyz789",
+ "three_letter_abbreviation": "abc123",
"two_letter_abbreviation": "abc123"
}
@@ -37851,7 +37100,7 @@ Example
GiftRegistryDynamicAttributeInput
],
"event_name": "xyz789",
- "gift_registry_type_uid": 4,
+ "gift_registry_type_uid": "4",
"message": "abc123",
"privacy_settings": "PRIVATE",
"registrants": [AddGiftRegistryRegistrantInput],
@@ -37932,7 +37181,7 @@ Fields
Example
- {"cart_uid": 4}
+ {"cart_uid": "4"}
@@ -38028,8 +37277,8 @@ Fields
Example
{
"response_message": "xyz789",
- "result": 123,
- "result_code": 987,
+ "result": 987,
+ "result_code": 123,
"secure_token": "xyz789",
"secure_token_id": "xyz789"
}
@@ -38099,7 +37348,7 @@ Example
{
"cartId": "xyz789",
"location": "PRODUCT_DETAIL",
- "methodCode": "abc123",
+ "methodCode": "xyz789",
"paymentSource": "abc123",
"vaultIntent": false
}
@@ -38162,11 +37411,11 @@ Fields
Example
{
- "amount": 123.45,
+ "amount": 987.65,
"currency_code": "xyz789",
"id": "xyz789",
"mp_order_id": "xyz789",
- "status": "abc123"
+ "status": "xyz789"
}
@@ -38232,10 +37481,10 @@ Fields
Example
{
- "nickname": "abc123",
+ "nickname": "xyz789",
"ratings": [ProductReviewRatingInput],
- "sku": "xyz789",
- "summary": "xyz789",
+ "sku": "abc123",
+ "summary": "abc123",
"text": "xyz789"
}
@@ -38322,7 +37571,7 @@ Fields
Example
- {"currency": "AFN", "value": 987.65}
+ {"currency": "AFN", "value": 123.45}
@@ -38432,8 +37681,8 @@ Fields
Example
{
- "description": "abc123",
- "name": "abc123"
+ "description": "xyz789",
+ "name": "xyz789"
}
@@ -38521,7 +37770,7 @@ Fields
Example
{
"card_description": "xyz789",
- "setup_token_id": "abc123"
+ "setup_token_id": "xyz789"
}
@@ -38657,7 +37906,7 @@ Fields
Example
- {"setup_token": "abc123"}
+ {"setup_token": "xyz789"}
@@ -38803,8 +38052,8 @@ Example
{
"cc_exp_month": 987,
"cc_exp_year": 123,
- "cc_last_4": 123,
- "cc_type": "abc123"
+ "cc_last_4": 987,
+ "cc_type": "xyz789"
}
@@ -38939,7 +38188,7 @@ Example
"discounts": [Discount],
"id": "4",
"order_item": OrderItemInterface,
- "product_name": "xyz789",
+ "product_name": "abc123",
"product_sale_price": Money,
"product_sku": "abc123",
"quantity_refunded": 987.65
@@ -39019,12 +38268,12 @@ Possible Types
-
+
-
+
@@ -39051,7 +38300,7 @@ Example
"product_name": "xyz789",
"product_sale_price": Money,
"product_sku": "xyz789",
- "quantity_refunded": 123.45
+ "quantity_refunded": 987.65
}
@@ -39217,11 +38466,11 @@ Fields
Example
{
"available_currency_codes": ["xyz789"],
- "base_currency_code": "xyz789",
+ "base_currency_code": "abc123",
"base_currency_symbol": "xyz789",
"default_display_currecy_code": "xyz789",
- "default_display_currecy_symbol": "xyz789",
- "default_display_currency_code": "xyz789",
+ "default_display_currecy_symbol": "abc123",
+ "default_display_currency_code": "abc123",
"default_display_currency_symbol": "xyz789",
"exchange_rates": [ExchangeRate]
}
@@ -40600,12 +39849,12 @@ Possible Types
Example
{
"code": 4,
- "default_value": "abc123",
+ "default_value": "xyz789",
"entity_type": "CATALOG_PRODUCT",
"frontend_class": "abc123",
"frontend_input": "BOOLEAN",
"is_required": true,
- "is_unique": true,
+ "is_unique": false,
"label": "xyz789",
"options": [CustomAttributeOptionInterface]
}
@@ -40671,7 +39920,7 @@ Possible Types
Example
{
- "is_default": false,
+ "is_default": true,
"label": "xyz789",
"value": "abc123"
}
@@ -40846,9 +40095,9 @@ giftRegistryUi
- group - CustomerGroupStorefront
+ group - CustomerGroup
- Customer group assigned to the customer
+ Name of the customer group assigned to the customer
group_id - Int
@@ -40858,9 +40107,10 @@ giftRegistryUi
- id - ID!
+ id - Int
+
+ The ID assigned to the customer. id is not needed as part of Customer, because on the server side, it can be identified based on the customer token used for authentication. There is no need to know customer ID on the client side.
- The unique ID assigned to the customer.
is_subscribed - Boolean
@@ -41127,7 +40377,7 @@ currentPage The role name and permissions assigned to the company user.
- segments - [CustomerSegmentStorefront]
+ segments - [CustomerSegment]
Customer segments associated with the current customer
@@ -41228,24 +40478,24 @@ Example
"companies": UserCompaniesOutput,
"compare_list": CompareList,
"confirmation_status": "ACCOUNT_CONFIRMED",
- "created_at": "abc123",
+ "created_at": "xyz789",
"custom_attributes": [AttributeValueInterface],
"date_of_birth": "xyz789",
"default_billing": "xyz789",
"default_shipping": "abc123",
- "dob": "xyz789",
- "email": "abc123",
+ "dob": "abc123",
+ "email": "xyz789",
"firstname": "abc123",
"gender": 123,
"gift_registries": [GiftRegistry],
"gift_registry": GiftRegistry,
- "group": CustomerGroupStorefront,
+ "group": CustomerGroup,
"group_id": 123,
- "id": "4",
- "is_subscribed": false,
- "job_title": "abc123",
- "lastname": "abc123",
- "middlename": "xyz789",
+ "id": 123,
+ "is_subscribed": true,
+ "job_title": "xyz789",
+ "lastname": "xyz789",
+ "middlename": "abc123",
"orders": CustomerOrders,
"prefix": "xyz789",
"purchase_order": PurchaseOrder,
@@ -41253,21 +40503,21 @@ Example
"purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata,
"purchase_order_approval_rules": PurchaseOrderApprovalRules,
"purchase_orders": PurchaseOrders,
- "purchase_orders_enabled": false,
+ "purchase_orders_enabled": true,
"requisition_lists": RequisitionLists,
"return": Return,
"returns": Returns,
"reviews": ProductReviews,
"reward_points": RewardPoints,
"role": CompanyRole,
- "segments": [CustomerSegmentStorefront],
+ "segments": [CustomerSegment],
"status": "ACTIVE",
"store_credit": CustomerStoreCredit,
- "structure_id": 4,
- "suffix": "abc123",
+ "structure_id": "4",
+ "suffix": "xyz789",
"taxvat": "xyz789",
"team": CompanyTeam,
- "telephone": "xyz789",
+ "telephone": "abc123",
"wishlist": Wishlist,
"wishlist_v2": Wishlist,
"wishlists": [Wishlist]
@@ -41376,10 +40626,9 @@ attributeCodes
The first name of the person associated with the shipping/billing address.
- id - Int
-
- The ID of a CustomerAddress object. Use uid instead.
+ id - Int
+ The ID of a CustomerAddress object.
lastname - String
@@ -41426,11 +40675,6 @@ attributeCodes
The customer's telephone number.
-
- uid - ID
-
- The unique ID for a CustomerAddress object.
-
vat_id - String
@@ -41444,29 +40688,28 @@ attributeCodes
Example
{
- "city": "xyz789",
+ "city": "abc123",
"company": "xyz789",
"country_code": "AF",
- "country_id": "abc123",
+ "country_id": "xyz789",
"custom_attributes": [CustomerAddressAttribute],
"custom_attributesV2": [AttributeValueInterface],
"customer_id": 987,
- "default_billing": true,
- "default_shipping": true,
+ "default_billing": false,
+ "default_shipping": false,
"extension_attributes": [CustomerAddressAttribute],
"fax": "xyz789",
"firstname": "abc123",
"id": 987,
- "lastname": "xyz789",
+ "lastname": "abc123",
"middlename": "abc123",
"postcode": "abc123",
- "prefix": "abc123",
+ "prefix": "xyz789",
"region": CustomerAddressRegion,
- "region_id": 987,
+ "region_id": 123,
"street": ["xyz789"],
"suffix": "xyz789",
- "telephone": "abc123",
- "uid": 4,
+ "telephone": "xyz789",
"vat_id": "xyz789"
}
@@ -41514,7 +40757,7 @@ Fields
Example
{
"attribute_code": "abc123",
- "value": "abc123"
+ "value": "xyz789"
}
@@ -41563,7 +40806,7 @@ Fields
Example
{
"attribute_code": "xyz789",
- "value": "abc123"
+ "value": "xyz789"
}
@@ -41715,24 +40958,24 @@ Fields
Example
{
- "city": "abc123",
+ "city": "xyz789",
"company": "abc123",
"country_code": "AF",
"country_id": "AF",
"custom_attributes": [CustomerAddressAttributeInput],
"custom_attributesV2": [AttributeValueInput],
- "default_billing": false,
+ "default_billing": true,
"default_shipping": false,
"fax": "xyz789",
- "firstname": "xyz789",
- "lastname": "abc123",
- "middlename": "abc123",
+ "firstname": "abc123",
+ "lastname": "xyz789",
+ "middlename": "xyz789",
"postcode": "xyz789",
"prefix": "xyz789",
"region": CustomerAddressRegionInput,
"street": ["xyz789"],
- "suffix": "xyz789",
- "telephone": "abc123",
+ "suffix": "abc123",
+ "telephone": "xyz789",
"vat_id": "xyz789"
}
@@ -41785,7 +41028,7 @@ Fields
Example
{
"region": "abc123",
- "region_code": "abc123",
+ "region_code": "xyz789",
"region_id": 987
}
@@ -41840,9 +41083,9 @@ Fields
Example
{
- "region": "abc123",
- "region_code": "abc123",
- "region_id": 987
+ "region": "xyz789",
+ "region_code": "xyz789",
+ "region_id": 123
}
@@ -41995,13 +41238,13 @@ Example
"code": "4",
"default_value": "xyz789",
"entity_type": "CATALOG_PRODUCT",
- "frontend_class": "xyz789",
+ "frontend_class": "abc123",
"frontend_input": "BOOLEAN",
"input_filter": "NONE",
"is_required": true,
- "is_unique": true,
+ "is_unique": false,
"label": "abc123",
- "multiline_count": 123,
+ "multiline_count": 987,
"options": [CustomAttributeOptionInterface],
"sort_order": 987,
"validate_rules": [ValidationRule]
@@ -42129,16 +41372,16 @@ Example
"custom_attributes": [AttributeValueInput],
"date_of_birth": "xyz789",
"dob": "abc123",
- "email": "xyz789",
+ "email": "abc123",
"firstname": "abc123",
"gender": 987,
- "is_subscribed": false,
- "lastname": "xyz789",
+ "is_subscribed": true,
+ "lastname": "abc123",
"middlename": "xyz789",
"password": "abc123",
"prefix": "abc123",
"suffix": "abc123",
- "taxvat": "abc123"
+ "taxvat": "xyz789"
}
@@ -42202,8 +41445,8 @@ Example
"date": "abc123",
"download_url": "xyz789",
"order_increment_id": "abc123",
- "remaining_downloads": "abc123",
- "status": "abc123"
+ "remaining_downloads": "xyz789",
+ "status": "xyz789"
}
@@ -42249,11 +41492,11 @@ Example
-
+
- CustomerGroupStorefront
+ CustomerGroup
@@ -42271,9 +41514,9 @@ Fields
- uid - ID!
+ name - String
- The unique ID for a CustomerGroup object.
+ The name of customer group.
@@ -42282,7 +41525,7 @@ Fields
Example
- {"uid": 4}
+ {"name": "xyz789"}
@@ -42391,17 +41634,17 @@ Fields
Example
{
"date_of_birth": "xyz789",
- "dob": "abc123",
- "email": "abc123",
- "firstname": "abc123",
+ "dob": "xyz789",
+ "email": "xyz789",
+ "firstname": "xyz789",
"gender": 987,
- "is_subscribed": true,
- "lastname": "xyz789",
+ "is_subscribed": false,
+ "lastname": "abc123",
"middlename": "xyz789",
"password": "abc123",
- "prefix": "abc123",
- "suffix": "xyz789",
- "taxvat": "abc123"
+ "prefix": "xyz789",
+ "suffix": "abc123",
+ "taxvat": "xyz789"
}
@@ -42635,34 +41878,34 @@ Example
"applied_gift_cards": [ApplyGiftCardToOrder],
"available_actions": ["REORDER"],
"billing_address": OrderAddress,
- "carrier": "xyz789",
+ "carrier": "abc123",
"comments": [SalesCommentItem],
"created_at": "xyz789",
"credit_memos": [CreditMemo],
"customer_info": OrderCustomerInfo,
- "email": "xyz789",
+ "email": "abc123",
"gift_message": GiftMessage,
- "gift_receipt_included": false,
+ "gift_receipt_included": true,
"gift_wrapping": GiftWrapping,
- "grand_total": 123.45,
+ "grand_total": 987.65,
"id": 4,
"increment_id": "xyz789",
"invoices": [Invoice],
"is_virtual": false,
"items": [OrderItemInterface],
"items_eligible_for_return": [OrderItemInterface],
- "number": "abc123",
- "order_date": "abc123",
- "order_number": "abc123",
+ "number": "xyz789",
+ "order_date": "xyz789",
+ "order_number": "xyz789",
"order_status_change_date": "xyz789",
"payment_methods": [OrderPaymentMethod],
- "printed_card_included": true,
+ "printed_card_included": false,
"returns": Returns,
"shipments": [OrderShipment],
"shipping_address": OrderAddress,
"shipping_method": "abc123",
- "status": "abc123",
- "token": "abc123",
+ "status": "xyz789",
+ "token": "xyz789",
"total": OrderTotal
}
@@ -42962,16 +42205,16 @@ Example
-
+
- CustomerSegmentStorefront
+ CustomerSegment
Description
- Customer segment details
+ Customer segment.
Fields
@@ -42984,9 +42227,19 @@ Fields
- uid - ID!
+ apply_to - CustomerSegmentApplyTo!
+
+ Customer segment is applicable to visitor, registered customer or both.
+
+
+ description - String
+
+ Customer segment description.
+
+
+ name - String!
- The unique ID for a CustomerSegment object.
+ Customer segment name.
@@ -42995,7 +42248,63 @@ Fields
Example
- {"uid": 4}
+ {
+ "apply_to": "BOTH",
+ "description": "xyz789",
+ "name": "abc123"
+}
+
+
+
+
+
+
+
+ Types
+
+ CustomerSegmentApplyTo
+
+
+
+ Description
+ Customer segment is applicable to visitor, registered customers or both.
+
+
+ Values
+
+
+
+ Enum Value
+ Description
+
+
+
+
+
+ BOTH
+
+ Customer segment is applicable to visitor and registered customers.
+
+
+
+ REGISTERED
+
+ Customer segment is applicable to registered customers.
+
+
+
+ VISITOR
+
+ Customer segment is applicable to visitors/guests.
+
+
+
+
+
+
+
+ Example
+ "BOTH"
@@ -43175,10 +42484,10 @@ Fields
Example
{
- "action": "xyz789",
+ "action": "abc123",
"actual_balance": Money,
"balance_change": Money,
- "date_time_changed": "abc123"
+ "date_time_changed": "xyz789"
}
@@ -43218,7 +42527,7 @@ Fields
Example
- {"token": "abc123"}
+ {"token": "xyz789"}
@@ -43326,18 +42635,18 @@ Fields
Example
{
- "allow_remote_shopping_assistance": false,
+ "allow_remote_shopping_assistance": true,
"custom_attributes": [AttributeValueInput],
- "date_of_birth": "abc123",
- "dob": "abc123",
+ "date_of_birth": "xyz789",
+ "dob": "xyz789",
"firstname": "xyz789",
- "gender": 123,
- "is_subscribed": false,
- "lastname": "abc123",
+ "gender": 987,
+ "is_subscribed": true,
+ "lastname": "xyz789",
"middlename": "xyz789",
- "prefix": "xyz789",
+ "prefix": "abc123",
"suffix": "xyz789",
- "taxvat": "abc123"
+ "taxvat": "xyz789"
}
@@ -43409,12 +42718,12 @@ Fields
Example
{
- "option_id": 123,
+ "option_id": 987,
"product_sku": "abc123",
- "required": true,
- "sort_order": 123,
- "title": "xyz789",
- "uid": "4",
+ "required": false,
+ "sort_order": 987,
+ "title": "abc123",
+ "uid": 4,
"value": CustomizableAreaValue
}
@@ -43476,11 +42785,11 @@ Fields
Example
{
- "max_characters": 987,
- "price": 123.45,
+ "max_characters": 123,
+ "price": 987.65,
"price_type": "FIXED",
"sku": "abc123",
- "uid": "4"
+ "uid": 4
}
@@ -43549,8 +42858,8 @@ Example
{
"option_id": 123,
"required": true,
- "sort_order": 123,
- "title": "abc123",
+ "sort_order": 987,
+ "title": "xyz789",
"uid": "4",
"value": [CustomizableCheckboxValue]
}
@@ -43624,12 +42933,12 @@ Fields
Example
{
"option_type_id": 123,
- "price": 123.45,
+ "price": 987.65,
"price_type": "FIXED",
- "sku": "xyz789",
- "sort_order": 123,
+ "sku": "abc123",
+ "sort_order": 987,
"title": "abc123",
- "uid": "4"
+ "uid": 4
}
@@ -43701,12 +43010,12 @@ Fields
Example
{
- "option_id": 987,
+ "option_id": 123,
"product_sku": "xyz789",
"required": true,
- "sort_order": 123,
+ "sort_order": 987,
"title": "xyz789",
- "uid": "4",
+ "uid": 4,
"value": CustomizableDateValue
}
@@ -43897,7 +43206,7 @@ Example
"option_id": 987,
"required": false,
"sort_order": 123,
- "title": "xyz789",
+ "title": "abc123",
"uid": 4,
"value": [CustomizableDropDownValue]
}
@@ -43971,11 +43280,11 @@ Fields
Example
{
"option_type_id": 987,
- "price": 123.45,
+ "price": 987.65,
"price_type": "FIXED",
"sku": "xyz789",
- "sort_order": 987,
- "title": "abc123",
+ "sort_order": 123,
+ "title": "xyz789",
"uid": 4
}
@@ -44050,10 +43359,10 @@ Example
{
"option_id": 987,
"product_sku": "abc123",
- "required": false,
+ "required": true,
"sort_order": 123,
"title": "xyz789",
- "uid": 4,
+ "uid": "4",
"value": CustomizableFieldValue
}
@@ -44118,7 +43427,7 @@ Example
"max_characters": 987,
"price": 123.45,
"price_type": "FIXED",
- "sku": "abc123",
+ "sku": "xyz789",
"uid": "4"
}
@@ -44193,9 +43502,9 @@ Example
{
"option_id": 987,
"product_sku": "xyz789",
- "required": true,
+ "required": false,
"sort_order": 123,
- "title": "abc123",
+ "title": "xyz789",
"uid": 4,
"value": CustomizableFileValue
}
@@ -44270,10 +43579,10 @@ Example
{
"file_extension": "xyz789",
"image_size_x": 987,
- "image_size_y": 987,
+ "image_size_y": 123,
"price": 123.45,
"price_type": "FIXED",
- "sku": "abc123",
+ "sku": "xyz789",
"uid": 4
}
@@ -44341,11 +43650,11 @@ Fields
Example
{
- "option_id": 123,
- "required": false,
- "sort_order": 987,
+ "option_id": 987,
+ "required": true,
+ "sort_order": 123,
"title": "xyz789",
- "uid": "4",
+ "uid": 4,
"value": [CustomizableMultipleValue]
}
@@ -44418,12 +43727,12 @@ Fields
Example
{
"option_type_id": 123,
- "price": 123.45,
+ "price": 987.65,
"price_type": "FIXED",
- "sku": "abc123",
+ "sku": "xyz789",
"sort_order": 987,
"title": "abc123",
- "uid": "4"
+ "uid": 4
}
@@ -44479,7 +43788,7 @@ Example
{
"id": 123,
"uid": 4,
- "value_string": "abc123"
+ "value_string": "xyz789"
}
@@ -44595,9 +43904,9 @@ Example
{
"option_id": 123,
"required": true,
- "sort_order": 123,
+ "sort_order": 987,
"title": "abc123",
- "uid": "4"
+ "uid": 4
}
@@ -44659,12 +43968,12 @@ Possible Types
-
+
-
+
@@ -44747,7 +44056,7 @@ Example
{
"option_id": 987,
"required": false,
- "sort_order": 987,
+ "sort_order": 123,
"title": "xyz789",
"uid": 4,
"value": [CustomizableRadioValue]
@@ -44822,10 +44131,10 @@ Fields
Example
{
"option_type_id": 123,
- "price": 987.65,
+ "price": 123.45,
"price_type": "FIXED",
- "sku": "abc123",
- "sort_order": 987,
+ "sku": "xyz789",
+ "sort_order": 123,
"title": "abc123",
"uid": "4"
}
@@ -44906,7 +44215,7 @@ Fields
Example
- {"success": true}
+ {"success": false}
@@ -45075,7 +44384,7 @@ Fields
Example
{
"errors": [NegotiableQuoteInvalidStateError],
- "quote_uid": 4
+ "quote_uid": "4"
}
@@ -45155,7 +44464,7 @@ Fields
Example
- {"template_id": 4}
+ {"template_id": "4"}
@@ -45191,7 +44500,7 @@ Fields
Example
- {"quote_uids": ["4"]}
+ {"quote_uids": [4]}
@@ -45321,7 +44630,7 @@ Fields
Example
{
"customerPaymentTokens": CustomerPaymentTokens,
- "result": true
+ "result": false
}
@@ -45450,7 +44759,7 @@ Fields
Example
- {"approval_rule_uids": [4]}
+ {"approval_rule_uids": ["4"]}
@@ -45616,7 +44925,7 @@ Fields
Example
- {"status": true, "wishlists": [Wishlist]}
+ {"status": false, "wishlists": [Wishlist]}
@@ -45689,10 +44998,10 @@ Example
"amount": Money,
"applied_to": "ITEM",
"coupon": AppliedCoupon,
- "is_discounting_locked": false,
+ "is_discounting_locked": true,
"label": "abc123",
- "type": "xyz789",
- "value": 987.65
+ "type": "abc123",
+ "value": 123.45
}
@@ -45813,7 +45122,7 @@ Example
"customizable_options": [SelectedCustomizableOption],
"discount": [Discount],
"errors": [CartItemError],
- "id": "xyz789",
+ "id": "abc123",
"is_available": false,
"links": [DownloadableProductLinks],
"max_qty": 987.65,
@@ -45823,9 +45132,9 @@ Example
"note_from_seller": [ItemNote],
"prices": CartItemPrices,
"product": ProductInterface,
- "quantity": 123.45,
+ "quantity": 987.65,
"samples": [DownloadableProductSamples],
- "uid": "4"
+ "uid": 4
}
@@ -45903,12 +45212,12 @@ Example
{
"discounts": [Discount],
"downloadable_links": [DownloadableItemsLinks],
- "id": "4",
+ "id": 4,
"order_item": OrderItemInterface,
- "product_name": "xyz789",
+ "product_name": "abc123",
"product_sale_price": Money,
- "product_sku": "xyz789",
- "quantity_refunded": 987.65
+ "product_sku": "abc123",
+ "quantity_refunded": 123.45
}
@@ -46032,12 +45341,12 @@ Example
{
"discounts": [Discount],
"downloadable_links": [DownloadableItemsLinks],
- "id": 4,
+ "id": "4",
"order_item": OrderItemInterface,
- "product_name": "abc123",
+ "product_name": "xyz789",
"product_sale_price": Money,
- "product_sku": "abc123",
- "quantity_invoiced": 987.65
+ "product_sku": "xyz789",
+ "quantity_invoiced": 123.45
}
@@ -46090,7 +45399,7 @@ Example
{
"sort_order": 987,
"title": "xyz789",
- "uid": 4
+ "uid": "4"
}
@@ -46243,7 +45552,7 @@ Example
{
"discounts": [Discount],
"downloadable_links": [DownloadableItemsLinks],
- "eligible_for_return": true,
+ "eligible_for_return": false,
"entered_options": [OrderItemOption],
"gift_message": GiftMessage,
"gift_wrapping": GiftWrapping,
@@ -46252,18 +45561,18 @@ Example
"product": ProductInterface,
"product_name": "xyz789",
"product_sale_price": Money,
- "product_sku": "xyz789",
- "product_type": "abc123",
+ "product_sku": "abc123",
+ "product_type": "xyz789",
"product_url_key": "xyz789",
- "quantity_canceled": 123.45,
+ "quantity_canceled": 987.65,
"quantity_invoiced": 123.45,
- "quantity_ordered": 123.45,
- "quantity_refunded": 123.45,
- "quantity_return_requested": 123.45,
+ "quantity_ordered": 987.65,
+ "quantity_refunded": 987.65,
+ "quantity_return_requested": 987.65,
"quantity_returned": 987.65,
"quantity_shipped": 987.65,
"selected_options": [OrderItemOption],
- "status": "abc123"
+ "status": "xyz789"
}
@@ -46649,6 +45958,11 @@ currentPage
+
+ rules - [CatalogRule]
+
+ Provides applied catalog rules in the current active cart
+
sale - Int
@@ -46824,15 +46138,15 @@ currentPage
Example
{
- "activity": "abc123",
+ "activity": "xyz789",
"attribute_set_id": 987,
"canonical_url": "xyz789",
"categories": [CategoryInterface],
- "category_gear": "xyz789",
+ "category_gear": "abc123",
"climate": "abc123",
- "collar": "xyz789",
- "color": 123,
- "country_of_manufacture": "xyz789",
+ "collar": "abc123",
+ "color": 987,
+ "country_of_manufacture": "abc123",
"created_at": "abc123",
"crosssell_products": [ProductInterface],
"custom_attributesV2": ProductCustomAttributes,
@@ -46843,77 +46157,78 @@ Example
"downloadable_product_samples": [
DownloadableProductSamples
],
- "eco_collection": 123,
- "erin_recommends": 123,
- "features_bags": "xyz789",
- "format": 987,
- "gender": "xyz789",
+ "eco_collection": 987,
+ "erin_recommends": 987,
+ "features_bags": "abc123",
+ "format": 123,
+ "gender": "abc123",
"gift_message_available": true,
- "gift_wrapping_available": true,
+ "gift_wrapping_available": false,
"gift_wrapping_price": Money,
- "id": 987,
+ "id": 123,
"image": ProductImage,
"is_returnable": "xyz789",
"links_purchased_separately": 123,
"links_title": "abc123",
- "manufacturer": 987,
+ "manufacturer": 123,
"material": "abc123",
"max_sale_qty": 987.65,
"media_gallery": [MediaGalleryInterface],
"media_gallery_entries": [MediaGalleryEntry],
- "meta_description": "xyz789",
- "meta_keyword": "xyz789",
+ "meta_description": "abc123",
+ "meta_keyword": "abc123",
"meta_title": "abc123",
- "min_sale_qty": 123.45,
- "name": "xyz789",
- "new": 123,
- "new_from_date": "abc123",
+ "min_sale_qty": 987.65,
+ "name": "abc123",
+ "new": 987,
+ "new_from_date": "xyz789",
"new_to_date": "abc123",
"only_x_left_in_stock": 987.65,
"options": [CustomizableOptionInterface],
"options_container": "xyz789",
- "pattern": "xyz789",
+ "pattern": "abc123",
"performance_fabric": 987,
"price": ProductPrices,
"price_range": PriceRange,
"price_tiers": [TierPrice],
"product_links": [ProductLinksInterface],
- "purpose": 987,
+ "purpose": 123,
"quantity": 987.65,
- "rating_summary": 987.65,
+ "rating_summary": 123.45,
"redirect_code": 123,
"related_products": [ProductInterface],
"relative_url": "xyz789",
"review_count": 987,
"reviews": ProductReviews,
- "sale": 987,
+ "rules": [CatalogRule],
+ "sale": 123,
"short_description": ComplexTextValue,
- "size": 987,
- "sku": "abc123",
- "sleeve": "abc123",
+ "size": 123,
+ "sku": "xyz789",
+ "sleeve": "xyz789",
"small_image": ProductImage,
"special_from_date": "abc123",
"special_price": 123.45,
"special_to_date": "xyz789",
- "staged": false,
+ "staged": true,
"stock_status": "IN_STOCK",
"strap_bags": "abc123",
"style_bags": "xyz789",
- "style_bottom": "abc123",
+ "style_bottom": "xyz789",
"style_general": "abc123",
"swatch_image": "abc123",
"thumbnail": ProductImage,
- "tier_price": 123.45,
+ "tier_price": 987.65,
"tier_prices": [ProductTierPrices],
"type": "CMS_PAGE",
- "type_id": "abc123",
- "uid": "4",
- "updated_at": "xyz789",
+ "type_id": "xyz789",
+ "uid": 4,
+ "updated_at": "abc123",
"upsell_products": [ProductInterface],
"url_key": "xyz789",
- "url_path": "abc123",
+ "url_path": "xyz789",
"url_rewrites": [UrlRewrite],
- "url_suffix": "abc123",
+ "url_suffix": "xyz789",
"websites": [Website]
}
@@ -47075,17 +46390,17 @@ Fields
Example
{
- "id": 123,
- "is_shareable": true,
+ "id": 987,
+ "is_shareable": false,
"link_type": "FILE",
"number_of_downloads": 123,
- "price": 987.65,
- "sample_file": "abc123",
+ "price": 123.45,
+ "sample_file": "xyz789",
"sample_type": "FILE",
- "sample_url": "abc123",
+ "sample_url": "xyz789",
"sort_order": 123,
"title": "xyz789",
- "uid": 4
+ "uid": "4"
}
@@ -47126,7 +46441,7 @@ Fields
Example
- {"link_id": 987}
+ {"link_id": 123}
@@ -47197,12 +46512,12 @@ Fields
Example
{
- "id": 123,
- "sample_file": "abc123",
+ "id": 987,
+ "sample_file": "xyz789",
"sample_type": "FILE",
"sample_url": "abc123",
- "sort_order": 987,
- "title": "abc123"
+ "sort_order": 123,
+ "title": "xyz789"
}
@@ -47273,7 +46588,7 @@ Example
"product": ProductInterface,
"quantity": 987.65,
"samples": [DownloadableProductSamples],
- "uid": 4
+ "uid": "4"
}
@@ -47349,7 +46664,7 @@ Fields
Example
{
- "added_at": "xyz789",
+ "added_at": "abc123",
"customizable_options": [SelectedCustomizableOption],
"description": "xyz789",
"id": "4",
@@ -47404,8 +46719,8 @@ Fields
Example
{
- "duplicated_quote_uid": "4",
- "quote_uid": 4
+ "duplicated_quote_uid": 4,
+ "quote_uid": "4"
}
@@ -47665,7 +46980,7 @@ Example
{
"items": [DynamicBlock],
"page_info": SearchResultPageInfo,
- "total_count": 123
+ "total_count": 987
}
@@ -47718,11 +47033,7 @@ Fields
Example
- {
- "dynamic_block_uids": ["4"],
- "locations": ["CONTENT"],
- "type": "SPECIFIED"
-}
+ {"dynamic_block_uids": [4], "locations": ["CONTENT"], "type": "SPECIFIED"}
@@ -47769,8 +47080,8 @@ Fields
Example
{
- "attribute_code": "xyz789",
- "value": "xyz789"
+ "attribute_code": "abc123",
+ "value": "abc123"
}
@@ -47817,7 +47128,10 @@ Fields
Example
- {"uid": 4, "value": "abc123"}
+ {
+ "uid": "4",
+ "value": "xyz789"
+}
@@ -47885,9 +47199,9 @@ Fields
Example
{
- "canonical_url": "xyz789",
- "entity_uid": 4,
- "id": 123,
+ "canonical_url": "abc123",
+ "entity_uid": "4",
+ "id": 987,
"redirectCode": 123,
"relative_url": "xyz789",
"type": "CMS_PAGE"
@@ -47959,7 +47273,7 @@ Possible Types
Example
{
"code": "PRODUCT_NOT_FOUND",
- "message": "abc123"
+ "message": "xyz789"
}
@@ -48022,7 +47336,7 @@ Possible Types
Example
- {"message": "xyz789"}
+ {"message": "abc123"}
@@ -48076,7 +47390,7 @@ Fields
Example
{
"country_code": "AF",
- "postcode": "xyz789",
+ "postcode": "abc123",
"region": CustomerAddressRegionInput
}
@@ -48128,7 +47442,7 @@ Fields
Example
{
"address": EstimateAddressInput,
- "cart_id": "abc123",
+ "cart_id": "xyz789",
"shipping_method": ShippingMethodInput
}
@@ -48170,93 +47484,6 @@ Fields
Example
{"cart": Cart}
-
-
-
-
-
-
-
- Types
-
- ExchangeExternalCustomerTokenInput
-
-
-
- Description
- Contains details about external customer.
-
-
- Fields
-
-
-
- Input Field
- Description
-
-
-
-
-
- customer - CustomerCreateInput!
-
- An input object that defines the customer characteristics to update.
-
-
-
-
-
-
-
- Example
- {"customer": CustomerCreateInput}
-
-
-
-
-
-
-
- Types
-
- ExchangeExternalCustomerTokenOutput
-
-
-
- Description
- Contains customer token for external customer.
-
-
-
-
-
- Example
- {
- "customer": Customer,
- "token": "xyz789"
-}
@@ -48300,135 +47527,7 @@ Fields
Example
- {"currency_to": "xyz789", "rate": 987.65}
-
-
-
-
-
-
-
- Types
-
- FastlaneConfig
-
-
-
- Fields
-
-
-
- Field Name
- Description
-
-
-
-
- code - String
-
- The payment method code as defined in the payment gateway
-
-
- is_visible - Boolean
-
- Indicates whether the payment method is displayed
-
-
- payment_intent - String
-
- Defines the payment intent (Authorize or Capture
-
-
- payment_source - String
-
- The payment source for the payment method
-
-
- sdk_params - [SDKParams]
-
- The PayPal parameters required to load the JS SDK
-
-
- sort_order - String
-
- The relative order the payment method is displayed on the checkout page
-
-
- three_ds_mode - ThreeDSMode
-
- 3DS mode
-
-
- title - String
-
- The name displayed for the payment method
-
-
-
-
-
-
-
- Example
- {
- "code": "xyz789",
- "is_visible": false,
- "payment_intent": "abc123",
- "payment_source": "abc123",
- "sdk_params": [SDKParams],
- "sort_order": "abc123",
- "three_ds_mode": "OFF",
- "title": "xyz789"
-}
-
-
-
-
-
-
-
- Types
-
- FastlaneMethodInput
-
-
-
- Description
- Fastlane Payment inputs
-
-
-
-
-
- Example
- {
- "payment_source": "abc123",
- "paypal_fastlane_token": "abc123"
-}
+ {"currency_to": "abc123", "rate": 123.45}
@@ -48475,7 +47574,7 @@ Fields
Example
{
- "eq": "abc123",
+ "eq": "xyz789",
"in": ["xyz789"]
}
@@ -48567,7 +47666,7 @@ Fields
Example
- {"match": "abc123", "match_type": "FULL"}
+ {"match": "xyz789", "match_type": "FULL"}
@@ -48614,7 +47713,7 @@ Fields
Example
{
- "from": "abc123",
+ "from": "xyz789",
"to": "abc123"
}
@@ -48799,20 +47898,20 @@ Fields
Example
{
"eq": "abc123",
- "finset": ["abc123"],
- "from": "abc123",
- "gt": "xyz789",
- "gteq": "abc123",
+ "finset": ["xyz789"],
+ "from": "xyz789",
+ "gt": "abc123",
+ "gteq": "xyz789",
"in": ["xyz789"],
- "like": "xyz789",
+ "like": "abc123",
"lt": "abc123",
"lteq": "xyz789",
- "moreq": "abc123",
+ "moreq": "xyz789",
"neq": "xyz789",
- "nin": ["abc123"],
- "notnull": "abc123",
- "null": "xyz789",
- "to": "xyz789"
+ "nin": ["xyz789"],
+ "notnull": "xyz789",
+ "null": "abc123",
+ "to": "abc123"
}
@@ -48945,7 +48044,7 @@ Description
Example
- 987.65
+ 123.45
@@ -49064,7 +48163,7 @@ Fields
Example
- {"template_id": 4}
+ {"template_id": "4"}
@@ -49193,8 +48292,8 @@ Fields
Example
{
"balance": Money,
- "code": "abc123",
- "expiration_date": "xyz789"
+ "code": "xyz789",
+ "expiration_date": "abc123"
}
@@ -49235,7 +48334,7 @@ Fields
Example
- {"gift_card_code": "xyz789"}
+ {"gift_card_code": "abc123"}
@@ -49301,12 +48400,12 @@ Fields
Example
{
- "attribute_id": 987,
+ "attribute_id": 123,
"uid": 4,
"value": 987.65,
"value_id": 987,
- "website_id": 123,
- "website_value": 123.45
+ "website_id": 987,
+ "website_value": 987.65
}
@@ -49466,22 +48565,22 @@ Example
"errors": [CartItemError],
"gift_message": GiftMessage,
"gift_wrapping": GiftWrapping,
- "id": "abc123",
- "is_available": true,
- "max_qty": 123.45,
- "message": "xyz789",
- "min_qty": 123.45,
- "not_available_message": "xyz789",
+ "id": "xyz789",
+ "is_available": false,
+ "max_qty": 987.65,
+ "message": "abc123",
+ "min_qty": 987.65,
+ "not_available_message": "abc123",
"note_from_buyer": [ItemNote],
"note_from_seller": [ItemNote],
"prices": CartItemPrices,
"product": ProductInterface,
- "quantity": 123.45,
- "recipient_email": "xyz789",
- "recipient_name": "abc123",
+ "quantity": 987.65,
+ "recipient_email": "abc123",
+ "recipient_name": "xyz789",
"sender_email": "xyz789",
- "sender_name": "xyz789",
- "uid": 4
+ "sender_name": "abc123",
+ "uid": "4"
}
@@ -49555,12 +48654,12 @@ Example
{
"discounts": [Discount],
"gift_card": GiftCardItem,
- "id": "4",
+ "id": 4,
"order_item": OrderItemInterface,
- "product_name": "abc123",
+ "product_name": "xyz789",
"product_sale_price": Money,
- "product_sku": "abc123",
- "quantity_refunded": 123.45
+ "product_sku": "xyz789",
+ "quantity_refunded": 987.65
}
@@ -49634,12 +48733,12 @@ Example
{
"discounts": [Discount],
"gift_card": GiftCardItem,
- "id": "4",
+ "id": 4,
"order_item": OrderItemInterface,
"product_name": "abc123",
"product_sale_price": Money,
"product_sku": "abc123",
- "quantity_invoiced": 123.45
+ "quantity_invoiced": 987.65
}
@@ -49700,9 +48799,9 @@ Fields
Example
{
- "message": "abc123",
+ "message": "xyz789",
"recipient_email": "xyz789",
- "recipient_name": "abc123",
+ "recipient_name": "xyz789",
"sender_email": "xyz789",
"sender_name": "abc123"
}
@@ -49778,7 +48877,7 @@ Example
"amount": Money,
"custom_giftcard_amount": Money,
"message": "abc123",
- "recipient_email": "abc123",
+ "recipient_email": "xyz789",
"recipient_name": "abc123",
"sender_email": "abc123",
"sender_name": "xyz789"
@@ -49929,7 +49028,7 @@ Fields
Example
{
"discounts": [Discount],
- "eligible_for_return": true,
+ "eligible_for_return": false,
"entered_options": [OrderItemOption],
"gift_card": GiftCardItem,
"gift_message": GiftMessage,
@@ -49939,18 +49038,18 @@ Example
"product": ProductInterface,
"product_name": "xyz789",
"product_sale_price": Money,
- "product_sku": "abc123",
- "product_type": "xyz789",
+ "product_sku": "xyz789",
+ "product_type": "abc123",
"product_url_key": "xyz789",
- "quantity_canceled": 123.45,
+ "quantity_canceled": 987.65,
"quantity_invoiced": 987.65,
- "quantity_ordered": 987.65,
- "quantity_refunded": 123.45,
+ "quantity_ordered": 123.45,
+ "quantity_refunded": 987.65,
"quantity_return_requested": 987.65,
- "quantity_returned": 987.65,
+ "quantity_returned": 123.45,
"quantity_shipped": 123.45,
"selected_options": [OrderItemOption],
- "status": "abc123"
+ "status": "xyz789"
}
@@ -50366,6 +49465,11 @@ currentPage
+
+ rules - [CatalogRule]
+
+ Provides applied catalog rules in the current active cart
+
sale - Int
@@ -50546,15 +49650,15 @@ currentPage
Example
{
- "activity": "xyz789",
- "allow_message": false,
- "allow_open_amount": false,
- "attribute_set_id": 123,
- "canonical_url": "xyz789",
+ "activity": "abc123",
+ "allow_message": true,
+ "allow_open_amount": true,
+ "attribute_set_id": 987,
+ "canonical_url": "abc123",
"categories": [CategoryInterface],
- "category_gear": "abc123",
+ "category_gear": "xyz789",
"climate": "abc123",
- "collar": "abc123",
+ "collar": "xyz789",
"color": 123,
"country_of_manufacture": "abc123",
"created_at": "xyz789",
@@ -50562,9 +49666,9 @@ Example
"custom_attributesV2": ProductCustomAttributes,
"description": ComplexTextValue,
"eco_collection": 123,
- "erin_recommends": 987,
- "features_bags": "abc123",
- "format": 123,
+ "erin_recommends": 123,
+ "features_bags": "xyz789",
+ "format": 987,
"gender": "abc123",
"gift_card_options": [CustomizableOptionInterface],
"gift_message_available": false,
@@ -50574,7 +49678,7 @@ Example
"giftcard_type": "VIRTUAL",
"id": 987,
"image": ProductImage,
- "is_redeemable": false,
+ "is_redeemable": true,
"is_returnable": "xyz789",
"lifetime": 987,
"manufacturer": 987,
@@ -50583,63 +49687,64 @@ Example
"media_gallery": [MediaGalleryInterface],
"media_gallery_entries": [MediaGalleryEntry],
"message_max_length": 123,
- "meta_description": "xyz789",
+ "meta_description": "abc123",
"meta_keyword": "xyz789",
"meta_title": "abc123",
- "min_sale_qty": 123.45,
+ "min_sale_qty": 987.65,
"name": "xyz789",
- "new": 123,
+ "new": 987,
"new_from_date": "xyz789",
- "new_to_date": "xyz789",
- "only_x_left_in_stock": 987.65,
- "open_amount_max": 987.65,
+ "new_to_date": "abc123",
+ "only_x_left_in_stock": 123.45,
+ "open_amount_max": 123.45,
"open_amount_min": 123.45,
"options": [CustomizableOptionInterface],
- "options_container": "abc123",
- "pattern": "xyz789",
- "performance_fabric": 987,
+ "options_container": "xyz789",
+ "pattern": "abc123",
+ "performance_fabric": 123,
"price": ProductPrices,
"price_range": PriceRange,
"price_tiers": [TierPrice],
"product_links": [ProductLinksInterface],
- "purpose": 123,
+ "purpose": 987,
"quantity": 123.45,
- "rating_summary": 987.65,
- "redirect_code": 123,
+ "rating_summary": 123.45,
+ "redirect_code": 987,
"related_products": [ProductInterface],
"relative_url": "abc123",
"review_count": 987,
"reviews": ProductReviews,
- "sale": 123,
+ "rules": [CatalogRule],
+ "sale": 987,
"short_description": ComplexTextValue,
"size": 123,
"sku": "xyz789",
"sleeve": "xyz789",
"small_image": ProductImage,
"special_from_date": "abc123",
- "special_price": 987.65,
- "special_to_date": "abc123",
- "staged": true,
+ "special_price": 123.45,
+ "special_to_date": "xyz789",
+ "staged": false,
"stock_status": "IN_STOCK",
"strap_bags": "xyz789",
- "style_bags": "abc123",
- "style_bottom": "abc123",
- "style_general": "abc123",
- "swatch_image": "xyz789",
+ "style_bags": "xyz789",
+ "style_bottom": "xyz789",
+ "style_general": "xyz789",
+ "swatch_image": "abc123",
"thumbnail": ProductImage,
- "tier_price": 123.45,
+ "tier_price": 987.65,
"tier_prices": [ProductTierPrices],
"type": "CMS_PAGE",
"type_id": "xyz789",
"uid": 4,
- "updated_at": "abc123",
+ "updated_at": "xyz789",
"upsell_products": [ProductInterface],
- "url_key": "abc123",
- "url_path": "xyz789",
+ "url_key": "xyz789",
+ "url_path": "abc123",
"url_rewrites": [UrlRewrite],
- "url_suffix": "xyz789",
+ "url_suffix": "abc123",
"websites": [Website],
- "weight": 123.45
+ "weight": 987.65
}
@@ -50703,8 +49808,8 @@ Example
"customizable_options": [SelectedCustomizableOption],
"gift_card_options": GiftCardOptions,
"product": ProductInterface,
- "quantity": 123.45,
- "uid": "4"
+ "quantity": 987.65,
+ "uid": 4
}
@@ -50772,9 +49877,9 @@ Fields
Example
{
"gift_card": GiftCardItem,
- "id": "4",
+ "id": 4,
"order_item": OrderItemInterface,
- "product_name": "abc123",
+ "product_name": "xyz789",
"product_sale_price": Money,
"product_sku": "xyz789",
"quantity_shipped": 123.45
@@ -50903,60 +50008,13 @@ Fields
Example
{
- "added_at": "abc123",
+ "added_at": "xyz789",
"customizable_options": [SelectedCustomizableOption],
- "description": "abc123",
+ "description": "xyz789",
"gift_card_options": GiftCardOptions,
"id": 4,
"product": ProductInterface,
- "quantity": 123.45
-}
-
-
-
-
-
-
-
- Types
-
- GiftCartAttributeValue
-
-
-
- Description
- Gift card custom attribute value containing array data.
-
-
-
-
-
- Example
- {
- "code": "4",
- "options": ["abc123"]
+ "quantity": 987.65
}
@@ -51007,9 +50065,9 @@ Fields
Example
{
- "from": "xyz789",
+ "from": "abc123",
"message": "abc123",
- "to": "abc123"
+ "to": "xyz789"
}
@@ -51064,8 +50122,8 @@ Fields
Example
{
"from": "abc123",
- "message": "xyz789",
- "to": "abc123"
+ "message": "abc123",
+ "to": "xyz789"
}
@@ -51232,7 +50290,7 @@ Fields
Example
{
- "created_at": "xyz789",
+ "created_at": "abc123",
"dynamic_attributes": [GiftRegistryDynamicAttribute],
"event_name": "abc123",
"items": [GiftRegistryItemInterface],
@@ -51243,7 +50301,7 @@ Example
"shipping_address": CustomerAddress,
"status": "ACTIVE",
"type": GiftRegistryType,
- "uid": 4
+ "uid": "4"
}
@@ -51295,10 +50353,10 @@ Fields
Example
{
- "code": 4,
+ "code": "4",
"group": "EVENT_INFORMATION",
"label": "xyz789",
- "value": "abc123"
+ "value": "xyz789"
}
@@ -51492,8 +50550,8 @@ Possible Types
Example
{
- "code": 4,
- "label": "abc123",
+ "code": "4",
+ "label": "xyz789",
"value": "abc123"
}
@@ -51556,9 +50614,9 @@ Fields
Example
{
- "attribute_group": "xyz789",
- "code": 4,
- "input_type": "xyz789",
+ "attribute_group": "abc123",
+ "code": "4",
+ "input_type": "abc123",
"is_required": false,
"label": "abc123",
"sort_order": 987
@@ -51640,12 +50698,12 @@ Possible Types
Example
{
- "attribute_group": "xyz789",
- "code": "4",
+ "attribute_group": "abc123",
+ "code": 4,
"input_type": "abc123",
"is_required": false,
"label": "abc123",
- "sort_order": 987
+ "sort_order": 123
}
@@ -51708,10 +50766,10 @@ Fields
Example
{
"created_at": "abc123",
- "note": "abc123",
+ "note": "xyz789",
"product": ProductInterface,
"quantity": 123.45,
- "quantity_fulfilled": 123.45,
+ "quantity_fulfilled": 987.65,
"uid": "4"
}
@@ -51791,12 +50849,12 @@ Possible Types
Example
{
- "created_at": "abc123",
- "note": "xyz789",
+ "created_at": "xyz789",
+ "note": "abc123",
"product": ProductInterface,
"quantity": 123.45,
"quantity_fulfilled": 123.45,
- "uid": 4
+ "uid": "4"
}
@@ -51923,7 +50981,7 @@ Example
{
"code": "OUT_OF_STOCK",
"gift_registry_item_uid": 4,
- "gift_registry_uid": 4,
+ "gift_registry_uid": "4",
"message": "xyz789",
"product_uid": 4
}
@@ -52146,9 +51204,9 @@ Example
GiftRegistryRegistrantDynamicAttribute
],
"email": "abc123",
- "firstname": "abc123",
+ "firstname": "xyz789",
"lastname": "xyz789",
- "uid": "4"
+ "uid": 4
}
@@ -52195,9 +51253,9 @@ Fields
Example
{
- "code": "4",
+ "code": 4,
"label": "abc123",
- "value": "xyz789"
+ "value": "abc123"
}
@@ -52263,12 +51321,12 @@ Fields
Example
{
- "event_date": "abc123",
- "event_title": "xyz789",
- "gift_registry_uid": 4,
- "location": "xyz789",
- "name": "xyz789",
- "type": "abc123"
+ "event_date": "xyz789",
+ "event_title": "abc123",
+ "gift_registry_uid": "4",
+ "location": "abc123",
+ "name": "abc123",
+ "type": "xyz789"
}
@@ -52308,12 +51366,6 @@ Fields
The ID assigned to this customer address.
-
-
- customer_address_uid - ID
-
- The unique ID assigned to this customer address.
-
@@ -52321,11 +51373,7 @@ Fields
Example
- {
- "address_data": CustomerAddressInput,
- "address_id": 4,
- "customer_address_uid": 4
-}
+ {"address_data": CustomerAddressInput, "address_id": 4}
@@ -52489,8 +51537,8 @@ Fields
Example
{
- "design": "xyz789",
- "id": "4",
+ "design": "abc123",
+ "id": 4,
"image": GiftWrappingImage,
"price": Money,
"uid": "4"
@@ -52539,8 +51587,8 @@ Fields
Example
{
- "label": "xyz789",
- "url": "xyz789"
+ "label": "abc123",
+ "url": "abc123"
}
@@ -52587,9 +51635,9 @@ Fields
Example
{
- "color": "abc123",
+ "color": "xyz789",
"height": 123,
- "type": "xyz789"
+ "type": "abc123"
}
@@ -52668,8 +51716,8 @@ Example
{
"button_styles": GooglePayButtonStyles,
"code": "abc123",
- "is_visible": true,
- "payment_intent": "abc123",
+ "is_visible": false,
+ "payment_intent": "xyz789",
"payment_source": "abc123",
"sdk_params": [SDKParams],
"sort_order": "xyz789",
@@ -52728,7 +51776,7 @@ Fields
Example
{
- "payment_source": "xyz789",
+ "payment_source": "abc123",
"payments_order_id": "xyz789",
"paypal_order_id": "xyz789"
}
@@ -53096,6 +52144,11 @@ currentPage
+
+ rules - [CatalogRule]
+
+ Provides applied catalog rules in the current active cart
+
sale - Int
@@ -53276,83 +52329,84 @@ currentPage
Example
{
- "activity": "abc123",
- "attribute_set_id": 123,
- "canonical_url": "xyz789",
+ "activity": "xyz789",
+ "attribute_set_id": 987,
+ "canonical_url": "abc123",
"categories": [CategoryInterface],
- "category_gear": "xyz789",
- "climate": "abc123",
+ "category_gear": "abc123",
+ "climate": "xyz789",
"collar": "abc123",
"color": 987,
- "country_of_manufacture": "xyz789",
- "created_at": "abc123",
+ "country_of_manufacture": "abc123",
+ "created_at": "xyz789",
"crosssell_products": [ProductInterface],
"custom_attributesV2": ProductCustomAttributes,
"description": ComplexTextValue,
"eco_collection": 987,
"erin_recommends": 987,
- "features_bags": "xyz789",
+ "features_bags": "abc123",
"format": 123,
"gender": "xyz789",
- "gift_message_available": true,
+ "gift_message_available": false,
"gift_wrapping_available": false,
"gift_wrapping_price": Money,
"id": 987,
"image": ProductImage,
- "is_returnable": "abc123",
+ "is_returnable": "xyz789",
"items": [GroupedProductItem],
"manufacturer": 123,
"material": "xyz789",
- "max_sale_qty": 987.65,
+ "max_sale_qty": 123.45,
"media_gallery": [MediaGalleryInterface],
"media_gallery_entries": [MediaGalleryEntry],
- "meta_description": "abc123",
+ "meta_description": "xyz789",
"meta_keyword": "xyz789",
- "meta_title": "xyz789",
- "min_sale_qty": 987.65,
- "name": "abc123",
- "new": 123,
+ "meta_title": "abc123",
+ "min_sale_qty": 123.45,
+ "name": "xyz789",
+ "new": 987,
"new_from_date": "xyz789",
- "new_to_date": "xyz789",
- "only_x_left_in_stock": 123.45,
- "options_container": "xyz789",
+ "new_to_date": "abc123",
+ "only_x_left_in_stock": 987.65,
+ "options_container": "abc123",
"pattern": "abc123",
"performance_fabric": 987,
"price": ProductPrices,
"price_range": PriceRange,
"price_tiers": [TierPrice],
"product_links": [ProductLinksInterface],
- "purpose": 987,
- "quantity": 987.65,
+ "purpose": 123,
+ "quantity": 123.45,
"rating_summary": 987.65,
- "redirect_code": 123,
+ "redirect_code": 987,
"related_products": [ProductInterface],
"relative_url": "abc123",
- "review_count": 987,
+ "review_count": 123,
"reviews": ProductReviews,
- "sale": 987,
+ "rules": [CatalogRule],
+ "sale": 123,
"short_description": ComplexTextValue,
"size": 123,
"sku": "xyz789",
"sleeve": "abc123",
"small_image": ProductImage,
- "special_from_date": "xyz789",
- "special_price": 987.65,
- "special_to_date": "xyz789",
- "staged": false,
+ "special_from_date": "abc123",
+ "special_price": 123.45,
+ "special_to_date": "abc123",
+ "staged": true,
"stock_status": "IN_STOCK",
"strap_bags": "abc123",
"style_bags": "abc123",
"style_bottom": "abc123",
"style_general": "xyz789",
- "swatch_image": "xyz789",
+ "swatch_image": "abc123",
"thumbnail": ProductImage,
- "tier_price": 987.65,
+ "tier_price": 123.45,
"tier_prices": [ProductTierPrices],
"type": "CMS_PAGE",
- "type_id": "xyz789",
+ "type_id": "abc123",
"uid": 4,
- "updated_at": "xyz789",
+ "updated_at": "abc123",
"upsell_products": [ProductInterface],
"url_key": "xyz789",
"url_path": "abc123",
@@ -53478,10 +52532,10 @@ Fields
Example
{
- "added_at": "abc123",
+ "added_at": "xyz789",
"customizable_options": [SelectedCustomizableOption],
"description": "xyz789",
- "id": 4,
+ "id": "4",
"product": ProductInterface,
"quantity": 123.45
}
@@ -53531,64 +52585,8 @@ Fields
Example
{
- "reason": "abc123",
- "token": "xyz789"
-}
-
-
-
-
-
-
-
- Types
-
- GuestOrderInformationInput
-
-
-
- Description
- Input to retrieve an order based on details.
-
-
-
-
-
- Example
- {
- "email": "xyz789",
- "lastname": "xyz789",
- "number": "xyz789"
+ "reason": "xyz789",
+ "token": "abc123"
}
@@ -53681,18 +52679,18 @@ Fields
Example
{
- "cc_vault_code": "abc123",
- "code": "abc123",
+ "cc_vault_code": "xyz789",
+ "code": "xyz789",
"is_vault_enabled": true,
"is_visible": true,
- "payment_intent": "abc123",
+ "payment_intent": "xyz789",
"payment_source": "abc123",
- "requires_card_details": true,
+ "requires_card_details": false,
"sdk_params": [SDKParams],
"sort_order": "xyz789",
- "three_ds": true,
+ "three_ds": false,
"three_ds_mode": "OFF",
- "title": "abc123"
+ "title": "xyz789"
}
@@ -53782,15 +52780,15 @@ Fields
Example
{
- "cardBin": "abc123",
- "cardExpiryMonth": "xyz789",
- "cardExpiryYear": "xyz789",
+ "cardBin": "xyz789",
+ "cardExpiryMonth": "abc123",
+ "cardExpiryYear": "abc123",
"cardLast4": "xyz789",
- "holderName": "abc123",
- "is_active_payment_token_enabler": false,
- "payment_source": "abc123",
+ "holderName": "xyz789",
+ "is_active_payment_token_enabler": true,
+ "payment_source": "xyz789",
"payments_order_id": "xyz789",
- "paypal_order_id": "abc123"
+ "paypal_order_id": "xyz789"
}
@@ -53838,7 +52836,7 @@ Fields
Example
{
- "cancel_url": "xyz789",
+ "cancel_url": "abc123",
"return_url": "xyz789"
}
@@ -53964,7 +52962,7 @@ Fields
Example
{
- "name": "xyz789",
+ "name": "abc123",
"value": "xyz789"
}
@@ -53987,7 +52985,7 @@ Description
Example
- "4"
+ 4
@@ -54028,7 +53026,7 @@ Fields
Example
{
- "thumbnail": "abc123",
+ "thumbnail": "xyz789",
"value": "abc123"
}
@@ -54141,8 +53139,8 @@ Fields
Example
{
"code": "PRODUCT_NOT_FOUND",
- "message": "abc123",
- "quantity": 987.65
+ "message": "xyz789",
+ "quantity": 123.45
}
@@ -54266,7 +53264,7 @@ Example
"comments": [SalesCommentItem],
"id": 4,
"items": [InvoiceItemInterface],
- "number": "abc123",
+ "number": "xyz789",
"total": InvoiceTotal
}
@@ -54335,12 +53333,12 @@ Fields
Example
{
"discounts": [Discount],
- "id": "4",
+ "id": 4,
"order_item": OrderItemInterface,
- "product_name": "abc123",
+ "product_name": "xyz789",
"product_sale_price": Money,
"product_sku": "xyz789",
- "quantity_invoiced": 987.65
+ "quantity_invoiced": 123.45
}
@@ -54417,12 +53415,12 @@ Possible Types
-
+
-
+
@@ -54444,7 +53442,7 @@ Possible Types
Example
{
"discounts": [Discount],
- "id": 4,
+ "id": "4",
"order_item": OrderItemInterface,
"product_name": "abc123",
"product_sale_price": Money,
@@ -54572,7 +53570,7 @@ Fields
Example
- {"is_email_available": true}
+ {"is_email_available": false}
@@ -54611,7 +53609,7 @@ Fields
Example
- {"is_email_available": true}
+ {"is_email_available": false}
@@ -54650,7 +53648,7 @@ Fields
Example
- {"is_role_name_available": true}
+ {"is_role_name_available": false}
@@ -54689,7 +53687,7 @@ Fields
Example
- {"is_email_available": true}
+ {"is_email_available": false}
@@ -54728,7 +53726,7 @@ Fields
Example
- {"is_email_available": true}
+ {"is_email_available": false}
@@ -54793,12 +53791,12 @@ Fields
Example
{
- "created_at": "xyz789",
+ "created_at": "abc123",
"creator_id": 123,
- "creator_type": 987,
- "negotiable_quote_item_uid": 4,
+ "creator_type": 123,
+ "negotiable_quote_item_uid": "4",
"note": "abc123",
- "note_uid": 4
+ "note_uid": "4"
}
@@ -54929,7 +53927,7 @@ Example
"price": Money,
"product_name": "abc123",
"product_sku": "abc123",
- "quantity": 987.65,
+ "quantity": 123.45,
"uid": "4"
}
@@ -55091,7 +54089,7 @@ Fields
Example
{
"items_count": 123,
- "label": "abc123",
+ "label": "xyz789",
"value_string": "abc123"
}
@@ -55164,9 +54162,9 @@ Possible Types
Example
{
- "items_count": 123,
+ "items_count": 987,
"label": "xyz789",
- "value_string": "xyz789"
+ "value_string": "abc123"
}
@@ -55220,9 +54218,9 @@ Fields
Example
{
- "note": "abc123",
+ "note": "xyz789",
"quote_item_uid": "4",
- "quote_uid": 4
+ "quote_uid": "4"
}
@@ -55315,9 +54313,9 @@ Example
"id": 123,
"label": "abc123",
"media_type": "xyz789",
- "position": 123,
- "types": ["abc123"],
- "uid": "4",
+ "position": 987,
+ "types": ["xyz789"],
+ "uid": 4,
"video_content": ProductMediaGalleryEntriesVideoContent
}
@@ -55361,11 +54359,6 @@ Fields
The media item's position after it has been sorted.
-
- types - [String]
-
- Array of image types. It can have the following values: image, small_image, thumbnail.
-
url - String
@@ -55402,10 +54395,9 @@ Possible Types
Example
{
"disabled": true,
- "label": "abc123",
+ "label": "xyz789",
"position": 123,
- "types": ["abc123"],
- "url": "abc123"
+ "url": "xyz789"
}
@@ -55482,7 +54474,7 @@ Fields
Example
{
- "layout": "abc123",
+ "layout": "xyz789",
"logo": MessageStyleLogo
}
@@ -55528,7 +54520,7 @@ Fields
Example
- {"currency": "AFN", "value": 987.65}
+ {"currency": "AFN", "value": 123.45}
@@ -55579,7 +54571,7 @@ Fields
Example
{
"gift_registry": GiftRegistry,
- "status": true,
+ "status": false,
"user_errors": [GiftRegistryItemsUserError]
}
@@ -55621,7 +54613,7 @@ Fields
Example
- {"requisitionListItemUids": [4]}
+ {"requisitionListItemUids": ["4"]}
@@ -55721,7 +54713,7 @@ Fields
Example
{
- "quote_item_uid": "4",
+ "quote_item_uid": 4,
"quote_uid": "4",
"requisition_list_uid": "4"
}
@@ -55940,10 +54932,10 @@ Example
"billing_address": NegotiableQuoteBillingAddress,
"buyer": NegotiableQuoteUser,
"comments": [NegotiableQuoteComment],
- "created_at": "abc123",
+ "created_at": "xyz789",
"email": "abc123",
"history": [NegotiableQuoteHistoryEntry],
- "is_virtual": false,
+ "is_virtual": true,
"items": [CartItemInterface],
"name": "abc123",
"prices": CartPrices,
@@ -55951,8 +54943,8 @@ Example
"shipping_addresses": [NegotiableQuoteShippingAddress],
"status": "SUBMITTED",
"total_quantity": 123.45,
- "uid": 4,
- "updated_at": "xyz789"
+ "uid": "4",
+ "updated_at": "abc123"
}
@@ -55998,8 +54990,8 @@ Fields
Example
{
- "code": "abc123",
- "label": "xyz789"
+ "code": "xyz789",
+ "label": "abc123"
}
@@ -56101,15 +55093,15 @@ Fields
Example
{
- "city": "abc123",
+ "city": "xyz789",
"company": "abc123",
"country_code": "abc123",
"firstname": "xyz789",
"lastname": "xyz789",
"postcode": "xyz789",
"region": "xyz789",
- "region_id": 123,
- "save_in_address_book": true,
+ "region_id": 987,
+ "save_in_address_book": false,
"street": ["abc123"],
"telephone": "xyz789"
}
@@ -56210,12 +55202,12 @@ Possible Types
Example
{
- "city": "abc123",
- "company": "abc123",
+ "city": "xyz789",
+ "company": "xyz789",
"country": NegotiableQuoteAddressCountry,
- "firstname": "xyz789",
+ "firstname": "abc123",
"lastname": "abc123",
- "postcode": "xyz789",
+ "postcode": "abc123",
"region": NegotiableQuoteAddressRegion,
"street": ["xyz789"],
"telephone": "abc123"
@@ -56269,9 +55261,9 @@ Fields
Example
{
- "code": "xyz789",
+ "code": "abc123",
"label": "abc123",
- "region_id": 123
+ "region_id": 987
}
@@ -56348,14 +55340,14 @@ Fields
Example
{
- "city": "xyz789",
- "company": "xyz789",
+ "city": "abc123",
+ "company": "abc123",
"country": NegotiableQuoteAddressCountry,
"firstname": "abc123",
"lastname": "xyz789",
"postcode": "abc123",
"region": NegotiableQuoteAddressRegion,
- "street": ["abc123"],
+ "street": ["xyz789"],
"telephone": "abc123"
}
@@ -56419,7 +55411,7 @@ Example
"address": NegotiableQuoteAddressInput,
"customer_address_uid": 4,
"same_as_shipping": true,
- "use_for_shipping": true
+ "use_for_shipping": false
}
@@ -56483,7 +55475,7 @@ Example
"author": NegotiableQuoteUser,
"created_at": "xyz789",
"creator_type": "BUYER",
- "text": "xyz789",
+ "text": "abc123",
"uid": 4
}
@@ -56569,7 +55561,7 @@ Fields
Example
- {"comment": "abc123"}
+ {"comment": "xyz789"}
@@ -56621,7 +55613,7 @@ Example
{
"new_value": "xyz789",
"old_value": "xyz789",
- "title": "xyz789"
+ "title": "abc123"
}
@@ -56844,7 +55836,7 @@ Example
"author": NegotiableQuoteUser,
"change_type": "CREATED",
"changes": NegotiableQuoteHistoryChanges,
- "created_at": "abc123",
+ "created_at": "xyz789",
"uid": "4"
}
@@ -56950,7 +55942,7 @@ Fields
Example
{
"new_expiration": "xyz789",
- "old_expiration": "xyz789"
+ "old_expiration": "abc123"
}
@@ -57167,7 +56159,7 @@ Fields
Example
- {"message": "abc123"}
+ {"message": "xyz789"}
@@ -57213,7 +56205,7 @@ Fields
Example
- {"quantity": 123.45, "quote_item_uid": 4}
+ {"quantity": 987.65, "quote_item_uid": 4}
@@ -57319,7 +56311,7 @@ Example
{
"document_identifier": "xyz789",
"document_name": "abc123",
- "link_id": "4",
+ "link_id": 4,
"reference_document_url": "abc123"
}
@@ -57408,12 +56400,12 @@ Fields
Example
{
"available_shipping_methods": [AvailableShippingMethod],
- "city": "abc123",
+ "city": "xyz789",
"company": "abc123",
"country": NegotiableQuoteAddressCountry,
- "firstname": "abc123",
+ "firstname": "xyz789",
"lastname": "abc123",
- "postcode": "abc123",
+ "postcode": "xyz789",
"region": NegotiableQuoteAddressRegion,
"selected_shipping_method": SelectedShippingMethod,
"street": ["abc123"],
@@ -57789,7 +56781,7 @@ Example
"is_virtual": false,
"items": [CartItemInterface],
"max_order_commitment": 123,
- "min_order_commitment": 123,
+ "min_order_commitment": 987,
"name": "xyz789",
"notifications": [QuoteTemplateNotificationMessage],
"prices": CartPrices,
@@ -57798,7 +56790,7 @@ Example
],
"shipping_addresses": [NegotiableQuoteShippingAddress],
"status": "abc123",
- "template_id": 4,
+ "template_id": "4",
"total_quantity": 123.45
}
@@ -57962,14 +56954,14 @@ Example
"activated_at": "abc123",
"company_name": "xyz789",
"expiration_date": "abc123",
- "is_min_max_qty_used": true,
+ "is_min_max_qty_used": false,
"last_shared_at": "xyz789",
"max_order_commitment": 123,
- "min_negotiated_grand_total": 123.45,
+ "min_negotiated_grand_total": 987.65,
"min_order_commitment": 123,
"name": "xyz789",
- "orders_placed": 987,
- "sales_rep_name": "abc123",
+ "orders_placed": 123,
+ "sales_rep_name": "xyz789",
"state": "xyz789",
"status": "abc123",
"submitted_by": "abc123",
@@ -58032,7 +57024,12 @@ Fields
Example
- {"item_id": 4, "max_qty": 987.65, "min_qty": 987.65, "quantity": 987.65}
+ {
+ "item_id": "4",
+ "max_qty": 123.45,
+ "min_qty": 987.65,
+ "quantity": 987.65
+}
@@ -58092,9 +57089,9 @@ Fields
Example
{
"document_identifier": "xyz789",
- "document_name": "xyz789",
- "link_id": 4,
- "reference_document_url": "xyz789"
+ "document_name": "abc123",
+ "link_id": "4",
+ "reference_document_url": "abc123"
}
@@ -58150,7 +57147,7 @@ Example
{
"address": NegotiableQuoteAddressInput,
"customer_address_uid": 4,
- "customer_notes": "xyz789"
+ "customer_notes": "abc123"
}
@@ -58297,7 +57294,7 @@ Example
"items": [NegotiableQuoteTemplateGridItem],
"page_info": SearchResultPageInfo,
"sort_fields": SortFields,
- "total_count": 987
+ "total_count": 123
}
@@ -58350,7 +57347,7 @@ Possible Types
Example
- {"quote_uid": 4}
+ {"quote_uid": "4"}
@@ -58389,7 +57386,7 @@ Fields
Example
- {"quote_uid": 4}
+ {"quote_uid": "4"}
@@ -58435,7 +57432,7 @@ Fields
Example
{
"firstname": "xyz789",
- "lastname": "abc123"
+ "lastname": "xyz789"
}
@@ -58494,7 +57491,7 @@ Example
"items": [NegotiableQuote],
"page_info": SearchResultPageInfo,
"sort_fields": SortFields,
- "total_count": 123
+ "total_count": 987
}
@@ -58540,7 +57537,7 @@ Fields
Example
{
- "message": "abc123",
+ "message": "xyz789",
"uid": "4"
}
@@ -58582,7 +57579,7 @@ Fields
Example
- {"template_id": 4}
+ {"template_id": "4"}
@@ -58630,7 +57627,7 @@ Fields
Example
{
"order_id": "abc123",
- "order_number": "xyz789"
+ "order_number": "abc123"
}
@@ -58815,21 +57812,21 @@ attributeCodes
Example
{
"city": "abc123",
- "company": "abc123",
+ "company": "xyz789",
"country_code": "AF",
"custom_attributesV2": [AttributeValueInterface],
- "fax": "abc123",
- "firstname": "abc123",
+ "fax": "xyz789",
+ "firstname": "xyz789",
"lastname": "abc123",
- "middlename": "abc123",
+ "middlename": "xyz789",
"postcode": "xyz789",
"prefix": "xyz789",
- "region": "abc123",
- "region_id": 4,
- "street": ["xyz789"],
+ "region": "xyz789",
+ "region_id": "4",
+ "street": ["abc123"],
"suffix": "abc123",
"telephone": "xyz789",
- "vat_id": "xyz789"
+ "vat_id": "abc123"
}
@@ -58886,12 +57883,68 @@ Fields
Example
{
- "firstname": "abc123",
+ "firstname": "xyz789",
"lastname": "abc123",
- "middlename": "abc123",
- "prefix": "xyz789",
+ "middlename": "xyz789",
+ "prefix": "abc123",
"suffix": "xyz789"
}
+
+
+
+
+
+
+
+ Types
+
+ OrderInformationInput
+
+
+
+ Description
+ Input to retrieve an order based on details.
+
+
+
+
+
+ Example
+ {
+ "email": "xyz789",
+ "lastname": "abc123",
+ "number": "xyz789"
+}
@@ -59033,7 +58086,7 @@ Fields
Example
{
"discounts": [Discount],
- "eligible_for_return": true,
+ "eligible_for_return": false,
"entered_options": [OrderItemOption],
"gift_message": GiftMessage,
"gift_wrapping": GiftWrapping,
@@ -59044,16 +58097,16 @@ Example
"product_sale_price": Money,
"product_sku": "xyz789",
"product_type": "abc123",
- "product_url_key": "abc123",
+ "product_url_key": "xyz789",
"quantity_canceled": 123.45,
"quantity_invoiced": 123.45,
- "quantity_ordered": 987.65,
+ "quantity_ordered": 123.45,
"quantity_refunded": 123.45,
"quantity_return_requested": 987.65,
- "quantity_returned": 987.65,
- "quantity_shipped": 123.45,
+ "quantity_returned": 123.45,
+ "quantity_shipped": 987.65,
"selected_options": [OrderItemOption],
- "status": "abc123"
+ "status": "xyz789"
}
@@ -59210,12 +58263,12 @@ Possible Types
-
+
-
+
@@ -59237,7 +58290,7 @@ Possible Types
Example
{
"discounts": [Discount],
- "eligible_for_return": true,
+ "eligible_for_return": false,
"entered_options": [OrderItemOption],
"gift_message": GiftMessage,
"gift_wrapping": GiftWrapping,
@@ -59246,18 +58299,18 @@ Example
"product": ProductInterface,
"product_name": "abc123",
"product_sale_price": Money,
- "product_sku": "xyz789",
+ "product_sku": "abc123",
"product_type": "xyz789",
- "product_url_key": "xyz789",
+ "product_url_key": "abc123",
"quantity_canceled": 123.45,
"quantity_invoiced": 987.65,
"quantity_ordered": 123.45,
- "quantity_refunded": 123.45,
- "quantity_return_requested": 987.65,
+ "quantity_refunded": 987.65,
+ "quantity_return_requested": 123.45,
"quantity_returned": 987.65,
- "quantity_shipped": 123.45,
+ "quantity_shipped": 987.65,
"selected_options": [OrderItemOption],
- "status": "xyz789"
+ "status": "abc123"
}
@@ -59303,8 +58356,8 @@ Fields
Example
{
- "label": "xyz789",
- "value": "abc123"
+ "label": "abc123",
+ "value": "xyz789"
}
@@ -59454,7 +58507,7 @@ Fields
Example
{
"additional_data": [KeyValue],
- "name": "xyz789",
+ "name": "abc123",
"type": "abc123"
}
@@ -59519,7 +58572,7 @@ Example
"comments": [SalesCommentItem],
"id": "4",
"items": [ShipmentItemInterface],
- "number": "xyz789",
+ "number": "abc123",
"tracking": [ShipmentTracking]
}
@@ -59561,7 +58614,7 @@ Fields
Example
- {"token": "xyz789"}
+ {"token": "abc123"}
@@ -59609,11 +58662,6 @@ Fields
The final total amount, including shipping, discounts, and taxes.
-
- grand_total_excl_tax - Money!
-
- The grand total of the order, excluding taxes.
-
shipping_handling - ShippingHandling
@@ -59677,7 +58725,6 @@ Example
"discounts": [Discount],
"gift_options": GiftOptionsPrices,
"grand_total": Money,
- "grand_total_excl_tax": Money,
"shipping_handling": ShippingHandling,
"subtotal": Money,
"subtotal_excl_tax": Money,
@@ -59735,8 +58782,8 @@ Fields
Example
{
- "payer_id": "xyz789",
- "token": "xyz789"
+ "payer_id": "abc123",
+ "token": "abc123"
}
@@ -59791,8 +58838,8 @@ Fields
Example
{
"cancel_url": "xyz789",
- "error_url": "abc123",
- "return_url": "xyz789"
+ "error_url": "xyz789",
+ "return_url": "abc123"
}
@@ -59897,9 +58944,9 @@ Fields
Example
{
"mode": "TEST",
- "paypal_url": "abc123",
- "secure_token": "xyz789",
- "secure_token_id": "xyz789"
+ "paypal_url": "xyz789",
+ "secure_token": "abc123",
+ "secure_token_id": "abc123"
}
@@ -59940,7 +58987,7 @@ Fields
Example
- {"cart_id": "xyz789"}
+ {"cart_id": "abc123"}
@@ -60036,7 +59083,7 @@ Fields
Example
{
- "cart_id": "xyz789",
+ "cart_id": "abc123",
"paypal_payload": "abc123"
}
@@ -60120,7 +59167,7 @@ Fields
Example
{
- "cart_id": "abc123",
+ "cart_id": "xyz789",
"urls": PayflowProUrlInput
}
@@ -60175,9 +59222,9 @@ Fields
Example
{
- "cancel_url": "xyz789",
+ "cancel_url": "abc123",
"error_url": "xyz789",
- "return_url": "abc123"
+ "return_url": "xyz789"
}
@@ -60267,11 +59314,6 @@ Possible Types
-
-
-
-
-
@@ -60280,12 +59322,12 @@ Possible Types
Example
{
- "code": "abc123",
- "is_visible": true,
+ "code": "xyz789",
+ "is_visible": false,
"payment_intent": "xyz789",
"sdk_params": [SDKParams],
- "sort_order": "abc123",
- "title": "abc123"
+ "sort_order": "xyz789",
+ "title": "xyz789"
}
@@ -60318,11 +59360,6 @@ Fields
ApplePay payment method configuration
-
- fastlane - FastlaneConfig
-
- Fastlane payment method configuration
-
google_pay - GooglePayConfig
@@ -60347,7 +59384,6 @@ Fields
Example
{
"apple_pay": ApplePayConfig,
- "fastlane": FastlaneConfig,
"google_pay": GooglePayConfig,
"hosted_fields": HostedFieldsConfig,
"smart_buttons": SmartButtonsConfig
@@ -60406,13 +59442,6 @@ Values
-
-
- START_OF_CHECKOUT
-
-
-
-
ADMIN
@@ -60552,12 +59581,6 @@ Fields
Required input for Apple Pay button
-
-
- payment_services_paypal_fastlane - FastlaneMethodInput
-
- Required input for fastlane
-
payment_services_paypal_google_pay - GooglePayMethodInput
@@ -60617,7 +59640,6 @@ Example
"payflowpro": PayflowProInput,
"payflowpro_cc_vault": VaultTokenInput,
"payment_services_paypal_apple_pay": ApplePayMethodInput,
- "payment_services_paypal_fastlane": FastlaneMethodInput,
"payment_services_paypal_google_pay": GooglePayMethodInput,
"payment_services_paypal_hosted_fields": HostedFieldsInput,
"payment_services_paypal_smart_buttons": SmartButtonMethodInput,
@@ -60680,9 +59702,9 @@ Fields
Example
{
"id": "xyz789",
- "mp_order_id": "abc123",
+ "mp_order_id": "xyz789",
"payment_source_details": PaymentSourceDetails,
- "status": "xyz789"
+ "status": "abc123"
}
@@ -60993,7 +60015,7 @@ Fields
Example
{
"payer_id": "abc123",
- "token": "xyz789"
+ "token": "abc123"
}
@@ -61061,7 +60083,7 @@ Example
{
"cart_id": "abc123",
"code": "abc123",
- "express_button": false,
+ "express_button": true,
"urls": PaypalExpressUrlsInput,
"use_paypal_credit": true
}
@@ -61156,7 +60178,7 @@ Fields
Example
{
- "edit": "abc123",
+ "edit": "xyz789",
"start": "abc123"
}
@@ -61217,9 +60239,9 @@ Fields
Example
{
- "cancel_url": "xyz789",
- "pending_url": "xyz789",
- "return_url": "abc123",
+ "cancel_url": "abc123",
+ "pending_url": "abc123",
+ "return_url": "xyz789",
"success_url": "abc123"
}
@@ -61297,7 +60319,7 @@ Possible Types
Example
- {"weight": 123.45}
+ {"weight": 987.65}
@@ -61424,19 +60446,19 @@ Example
{
"city": "xyz789",
"contact_name": "abc123",
- "country_id": "abc123",
+ "country_id": "xyz789",
"description": "xyz789",
- "email": "abc123",
+ "email": "xyz789",
"fax": "xyz789",
"latitude": 987.65,
- "longitude": 123.45,
- "name": "abc123",
- "phone": "xyz789",
+ "longitude": 987.65,
+ "name": "xyz789",
+ "phone": "abc123",
"pickup_location_code": "abc123",
- "postcode": "xyz789",
+ "postcode": "abc123",
"region": "abc123",
"region_id": 123,
- "street": "abc123"
+ "street": "xyz789"
}
@@ -61727,7 +60749,7 @@ Example
{
"items": [PickupLocation],
"page_info": SearchResultPageInfo,
- "total_count": 987
+ "total_count": 123
}
@@ -61768,7 +60790,7 @@ Fields
Example
- {"quote_uid": "4"}
+ {"quote_uid": 4}
@@ -61853,7 +60875,7 @@ Fields
Example
{
"code": "CART_NOT_FOUND",
- "message": "xyz789"
+ "message": "abc123"
}
@@ -62066,7 +61088,7 @@ Fields
- errors - [PlaceOrderError]
+ errors - [PlaceOrderError]!
An array of place order errors.
@@ -62433,7 +61455,7 @@ Example
{
"discount_percentage": 123.45,
"main_final_price": 987.65,
- "main_price": 987.65
+ "main_price": 123.45
}
@@ -63032,7 +62054,7 @@ Fields
Example
- {"amount_off": 123.45, "percent_off": 987.65}
+ {"amount_off": 123.45, "percent_off": 123.45}
@@ -63383,11 +62405,6 @@ Fields
The media item's position after it has been sorted.
-
- types - [String]
-
- Array of image types. It can have the following values: image, small_image, thumbnail.
-
url - String
@@ -63401,10 +62418,9 @@ Fields
Example
{
- "disabled": false,
- "label": "xyz789",
+ "disabled": true,
+ "label": "abc123",
"position": 987,
- "types": ["abc123"],
"url": "xyz789"
}
@@ -63838,6 +62854,11 @@ currentPage
+
+ rules - [CatalogRule]
+
+ Provides applied catalog rules in the current active cart
+
sale - Int
@@ -64029,12 +63050,12 @@ Possible Types
-
+
-
+
@@ -64056,83 +63077,84 @@ Possible Types
Example
{
"activity": "xyz789",
- "attribute_set_id": 123,
- "canonical_url": "abc123",
+ "attribute_set_id": 987,
+ "canonical_url": "xyz789",
"categories": [CategoryInterface],
- "category_gear": "abc123",
- "climate": "abc123",
- "collar": "xyz789",
+ "category_gear": "xyz789",
+ "climate": "xyz789",
+ "collar": "abc123",
"color": 987,
- "country_of_manufacture": "abc123",
+ "country_of_manufacture": "xyz789",
"created_at": "abc123",
"crosssell_products": [ProductInterface],
"custom_attributesV2": ProductCustomAttributes,
"description": ComplexTextValue,
- "eco_collection": 987,
- "erin_recommends": 123,
- "features_bags": "xyz789",
+ "eco_collection": 123,
+ "erin_recommends": 987,
+ "features_bags": "abc123",
"format": 987,
"gender": "abc123",
"gift_message_available": true,
"gift_wrapping_available": false,
"gift_wrapping_price": Money,
- "id": 123,
+ "id": 987,
"image": ProductImage,
- "is_returnable": "abc123",
- "manufacturer": 123,
+ "is_returnable": "xyz789",
+ "manufacturer": 987,
"material": "xyz789",
- "max_sale_qty": 987.65,
+ "max_sale_qty": 123.45,
"media_gallery": [MediaGalleryInterface],
"media_gallery_entries": [MediaGalleryEntry],
- "meta_description": "xyz789",
+ "meta_description": "abc123",
"meta_keyword": "xyz789",
"meta_title": "abc123",
"min_sale_qty": 987.65,
- "name": "abc123",
- "new": 987,
- "new_from_date": "abc123",
- "new_to_date": "abc123",
- "only_x_left_in_stock": 987.65,
- "options_container": "xyz789",
- "pattern": "xyz789",
- "performance_fabric": 987,
+ "name": "xyz789",
+ "new": 123,
+ "new_from_date": "xyz789",
+ "new_to_date": "xyz789",
+ "only_x_left_in_stock": 123.45,
+ "options_container": "abc123",
+ "pattern": "abc123",
+ "performance_fabric": 123,
"price": ProductPrices,
"price_range": PriceRange,
"price_tiers": [TierPrice],
"product_links": [ProductLinksInterface],
"purpose": 123,
"quantity": 123.45,
- "rating_summary": 987.65,
+ "rating_summary": 123.45,
"related_products": [ProductInterface],
"review_count": 123,
"reviews": ProductReviews,
+ "rules": [CatalogRule],
"sale": 987,
"short_description": ComplexTextValue,
- "size": 123,
+ "size": 987,
"sku": "xyz789",
"sleeve": "xyz789",
"small_image": ProductImage,
- "special_from_date": "xyz789",
+ "special_from_date": "abc123",
"special_price": 123.45,
- "special_to_date": "abc123",
+ "special_to_date": "xyz789",
"staged": true,
"stock_status": "IN_STOCK",
- "strap_bags": "abc123",
- "style_bags": "abc123",
- "style_bottom": "xyz789",
+ "strap_bags": "xyz789",
+ "style_bags": "xyz789",
+ "style_bottom": "abc123",
"style_general": "xyz789",
- "swatch_image": "abc123",
+ "swatch_image": "xyz789",
"thumbnail": ProductImage,
- "tier_price": 987.65,
+ "tier_price": 123.45,
"tier_prices": [ProductTierPrices],
"type_id": "abc123",
- "uid": "4",
- "updated_at": "xyz789",
+ "uid": 4,
+ "updated_at": "abc123",
"upsell_products": [ProductInterface],
"url_key": "abc123",
- "url_path": "abc123",
+ "url_path": "xyz789",
"url_rewrites": [UrlRewrite],
- "url_suffix": "xyz789",
+ "url_suffix": "abc123",
"websites": [Website]
}
@@ -64195,8 +63217,8 @@ Fields
Example
{
"link_type": "abc123",
- "linked_product_sku": "abc123",
- "linked_product_type": "abc123",
+ "linked_product_sku": "xyz789",
+ "linked_product_type": "xyz789",
"position": 123,
"sku": "abc123"
}
@@ -64276,11 +63298,11 @@ Possible Types
Example
{
- "link_type": "xyz789",
+ "link_type": "abc123",
"linked_product_sku": "xyz789",
- "linked_product_type": "xyz789",
+ "linked_product_type": "abc123",
"position": 123,
- "sku": "xyz789"
+ "sku": "abc123"
}
@@ -64331,9 +63353,9 @@ Fields
Example
{
- "base64_encoded_data": "xyz789",
- "name": "abc123",
- "type": "xyz789"
+ "base64_encoded_data": "abc123",
+ "name": "xyz789",
+ "type": "abc123"
}
@@ -64399,11 +63421,11 @@ Fields
Example
{
- "media_type": "xyz789",
- "video_description": "abc123",
- "video_metadata": "abc123",
- "video_provider": "abc123",
- "video_title": "abc123",
+ "media_type": "abc123",
+ "video_description": "xyz789",
+ "video_metadata": "xyz789",
+ "video_provider": "xyz789",
+ "video_title": "xyz789",
"video_url": "abc123"
}
@@ -64590,13 +63612,13 @@ Fields
Example
{
- "average_rating": 123.45,
- "created_at": "abc123",
+ "average_rating": 987.65,
+ "created_at": "xyz789",
"nickname": "xyz789",
"product": ProductInterface,
"ratings_breakdown": [ProductReviewRating],
"summary": "xyz789",
- "text": "abc123"
+ "text": "xyz789"
}
@@ -64642,7 +63664,7 @@ Fields
Example
{
- "name": "xyz789",
+ "name": "abc123",
"value": "abc123"
}
@@ -64691,8 +63713,8 @@ Fields
Example
{
- "id": "abc123",
- "value_id": "abc123"
+ "id": "xyz789",
+ "value_id": "xyz789"
}
@@ -64744,7 +63766,7 @@ Fields
Example
{
"id": "xyz789",
- "name": "abc123",
+ "name": "xyz789",
"values": [ProductReviewRatingValueMetadata]
}
@@ -64791,8 +63813,8 @@ Fields
Example
{
- "value": "xyz789",
- "value_id": "xyz789"
+ "value": "abc123",
+ "value_id": "abc123"
}
@@ -64992,11 +64014,11 @@ Fields
Example
{
- "customer_group_id": "abc123",
- "percentage_value": 987.65,
- "qty": 123.45,
- "value": 123.45,
- "website_id": 123.45
+ "customer_group_id": "xyz789",
+ "percentage_value": 123.45,
+ "qty": 987.65,
+ "value": 987.65,
+ "website_id": 987.65
}
@@ -65039,11 +64061,6 @@ Fields
The media item's position after it has been sorted.
-
- types - [String]
-
- Array of image types. It can have the following values: image, small_image, thumbnail.
-
url - String
@@ -65064,8 +64081,7 @@ Example
{
"disabled": true,
"label": "abc123",
- "position": 987,
- "types": ["xyz789"],
+ "position": 123,
"url": "abc123",
"video_content": ProductMediaGalleryEntriesVideoContent
}
@@ -65257,14 +64273,14 @@ Example
"approval_flow": [PurchaseOrderRuleApprovalFlow],
"available_actions": ["REJECT"],
"comments": [PurchaseOrderComment],
- "created_at": "xyz789",
+ "created_at": "abc123",
"created_by": Customer,
"history_log": [PurchaseOrderHistoryItem],
- "number": "abc123",
+ "number": "xyz789",
"order": CustomerOrder,
"quote": Cart,
"status": "PENDING",
- "uid": "4",
+ "uid": 4,
"updated_at": "abc123"
}
@@ -65375,7 +64391,7 @@ Fields
Example
- {"message": "abc123", "type": "NOT_FOUND"}
+ {"message": "xyz789", "type": "NOT_FOUND"}
@@ -65435,11 +64451,11 @@ Fields
Example
{
- "message": "abc123",
- "name": "abc123",
+ "message": "xyz789",
+ "name": "xyz789",
"role": "xyz789",
"status": "PENDING",
- "updated_at": "xyz789"
+ "updated_at": "abc123"
}
@@ -65580,8 +64596,8 @@ Example
"approver_roles": [CompanyRole],
"condition": PurchaseOrderApprovalRuleConditionInterface,
"created_at": "xyz789",
- "created_by": "xyz789",
- "description": "xyz789",
+ "created_by": "abc123",
+ "description": "abc123",
"name": "abc123",
"status": "ENABLED",
"uid": "4",
@@ -65812,7 +64828,7 @@ Fields
Example
- {"attribute": "GRAND_TOTAL", "operator": "MORE_THAN", "quantity": 123}
+ {"attribute": "GRAND_TOTAL", "operator": "MORE_THAN", "quantity": 987}
@@ -66269,10 +65285,10 @@ Fields
Example
{
- "activity": "xyz789",
- "created_at": "abc123",
- "message": "xyz789",
- "uid": "4"
+ "activity": "abc123",
+ "created_at": "xyz789",
+ "message": "abc123",
+ "uid": 4
}
@@ -66465,7 +65481,7 @@ Example
{
"items": [PurchaseOrder],
"page_info": SearchResultPageInfo,
- "total_count": 123
+ "total_count": 987
}
@@ -66614,7 +65630,7 @@ Example
{
"company_purchase_orders": true,
"created_date": FilterRangeTypeInput,
- "require_my_approval": false,
+ "require_my_approval": true,
"status": "PENDING"
}
@@ -66884,14 +65900,14 @@ Fields
Example
{
- "badge_position": "xyz789",
+ "badge_position": "abc123",
"language_code": "abc123",
"minimum_score": 987.65,
"re_captcha_type": "INVISIBLE",
"technical_failure_message": "xyz789",
"theme": "xyz789",
"validation_failure_message": "xyz789",
- "website_key": "xyz789"
+ "website_key": "abc123"
}
@@ -66967,14 +65983,14 @@ Fields
Example
{
- "badge_position": "xyz789",
+ "badge_position": "abc123",
"failure_message": "xyz789",
"forms": ["PLACE_ORDER"],
"is_enabled": true,
"language_code": "xyz789",
"minimum_score": 987.65,
"theme": "abc123",
- "website_key": "xyz789"
+ "website_key": "abc123"
}
@@ -67179,9 +66195,9 @@ Fields
Example
{
- "code": "abc123",
- "id": 123,
- "name": "abc123"
+ "code": "xyz789",
+ "id": 987,
+ "name": "xyz789"
}
@@ -67222,7 +66238,7 @@ Fields
Example
- {"cart_id": "abc123"}
+ {"cart_id": "xyz789"}
@@ -67308,8 +66324,8 @@ Fields
Example
{
- "cart_id": "abc123",
- "coupon_codes": ["xyz789"]
+ "cart_id": "xyz789",
+ "coupon_codes": ["abc123"]
}
@@ -67476,7 +66492,7 @@ Fields
Example
- {"success": false}
+ {"success": true}
@@ -67568,7 +66584,7 @@ Fields
Example
{
- "cart_id": "abc123",
+ "cart_id": "xyz789",
"cart_item_id": 123,
"cart_item_uid": "4"
}
@@ -67656,10 +66672,7 @@ Fields
Example
- {
- "quote_item_uids": ["4"],
- "quote_uid": "4"
-}
+ {"quote_item_uids": ["4"], "quote_uid": 4}
@@ -67744,10 +66757,7 @@ Fields
Example
- {
- "item_uids": ["4"],
- "template_id": "4"
-}
+ {"item_uids": ["4"], "template_id": 4}
@@ -67793,7 +66803,10 @@ Fields
Example
- {"products": [4], "uid": 4}
+ {
+ "products": ["4"],
+ "uid": "4"
+}
@@ -68090,9 +67103,9 @@ Fields
Example
{
- "quote_comment": "abc123",
+ "quote_comment": "xyz789",
"quote_name": "abc123",
- "quote_uid": 4
+ "quote_uid": "4"
}
@@ -68238,10 +67251,10 @@ Fields
Example
{
- "comment_text": "xyz789",
- "contact_email": "abc123",
+ "comment_text": "abc123",
+ "contact_email": "xyz789",
"items": [RequestReturnItemInput],
- "token": "xyz789"
+ "token": "abc123"
}
@@ -68301,10 +67314,10 @@ Fields
Example
{
- "cart_id": 4,
+ "cart_id": "4",
"comment": NegotiableQuoteCommentInput,
- "is_draft": false,
- "quote_name": "xyz789"
+ "is_draft": true,
+ "quote_name": "abc123"
}
@@ -68443,8 +67456,8 @@ Fields
Example
{
- "comment_text": "abc123",
- "contact_email": "xyz789",
+ "comment_text": "xyz789",
+ "contact_email": "abc123",
"items": [RequestReturnItemInput],
"order_uid": 4
}
@@ -68510,7 +67523,7 @@ Example
EnteredCustomAttributeInput
],
"order_item_uid": 4,
- "quantity_to_return": 123.45,
+ "quantity_to_return": 987.65,
"selected_custom_attributes": [
SelectedCustomAttributeInput
]
@@ -68666,10 +67679,10 @@ Example
{
"description": "xyz789",
"items": RequistionListItems,
- "items_count": 987,
+ "items_count": 123,
"name": "xyz789",
- "uid": 4,
- "updated_at": "xyz789"
+ "uid": "4",
+ "updated_at": "abc123"
}
@@ -68886,9 +67899,9 @@ Fields
Example
{
"entered_options": [EnteredOptionInput],
- "parent_sku": "xyz789",
+ "parent_sku": "abc123",
"quantity": 987.65,
- "selected_options": ["abc123"],
+ "selected_options": ["xyz789"],
"sku": "abc123"
}
@@ -68942,7 +67955,7 @@ Example
{
"items": [RequisitionList],
"page_info": SearchResultPageInfo,
- "total_count": 987
+ "total_count": 123
}
@@ -68995,7 +68008,7 @@ Example
{
"items": [RequisitionListItemInterface],
"page_info": SearchResultPageInfo,
- "total_pages": 123
+ "total_pages": 987
}
@@ -69083,10 +68096,10 @@ Example
{
"available_shipping_carriers": [ReturnShippingCarrier],
"comments": [ReturnComment],
- "created_at": "abc123",
+ "created_at": "xyz789",
"customer": ReturnCustomer,
"items": [ReturnItem],
- "number": "abc123",
+ "number": "xyz789",
"order": CustomerOrder,
"shipping": ReturnShipping,
"status": "PENDING",
@@ -69147,9 +68160,9 @@ Fields
Example
{
"author_name": "abc123",
- "created_at": "abc123",
- "text": "xyz789",
- "uid": "4"
+ "created_at": "xyz789",
+ "text": "abc123",
+ "uid": 4
}
@@ -69201,7 +68214,7 @@ Fields
Example
{
"label": "abc123",
- "uid": 4,
+ "uid": "4",
"value": "abc123"
}
@@ -69254,8 +68267,8 @@ Fields
Example
{
"email": "abc123",
- "firstname": "xyz789",
- "lastname": "abc123"
+ "firstname": "abc123",
+ "lastname": "xyz789"
}
@@ -69330,7 +68343,7 @@ Example
"custom_attributes": [ReturnCustomAttribute],
"custom_attributesV2": [AttributeValueInterface],
"order_item": OrderItemInterface,
- "quantity": 123.45,
+ "quantity": 987.65,
"request_quantity": 123.45,
"status": "PENDING",
"uid": 4
@@ -69435,17 +68448,17 @@ Fields
Example
{
"code": "4",
- "default_value": "abc123",
+ "default_value": "xyz789",
"entity_type": "CATALOG_PRODUCT",
"frontend_class": "abc123",
"frontend_input": "BOOLEAN",
"input_filter": "NONE",
- "is_required": false,
+ "is_required": true,
"is_unique": false,
"label": "abc123",
- "multiline_count": 123,
+ "multiline_count": 987,
"options": [CustomAttributeOptionInterface],
- "sort_order": 123,
+ "sort_order": 987,
"validate_rules": [ValidationRule]
}
@@ -69649,13 +68662,13 @@ Fields
Example
{
- "city": "xyz789",
+ "city": "abc123",
"contact_name": "abc123",
"country": Country,
"postcode": "abc123",
"region": Region,
- "street": ["xyz789"],
- "telephone": "abc123"
+ "street": ["abc123"],
+ "telephone": "xyz789"
}
@@ -69700,7 +68713,7 @@ Fields
Example
- {"label": "xyz789", "uid": 4}
+ {"label": "abc123", "uid": 4}
@@ -69757,7 +68770,7 @@ Example
{
"carrier": ReturnShippingCarrier,
"status": ReturnShippingTrackingStatus,
- "tracking_number": "abc123",
+ "tracking_number": "xyz789",
"uid": "4"
}
@@ -70060,7 +69073,7 @@ Fields
Example
- {"result": true}
+ {"result": false}
@@ -70216,8 +69229,8 @@ Example
{
"balance": RewardPointsAmount,
"change_reason": "xyz789",
- "date": "abc123",
- "points_change": 987.65
+ "date": "xyz789",
+ "points_change": 123.45
}
@@ -70309,7 +69322,7 @@ Fields
Example
- {"currency_amount": 987.65, "points": 987.65}
+ {"currency_amount": 123.45, "points": 123.45}
@@ -70476,12 +69489,12 @@ Possible Types
-
+
-
+
@@ -70491,17 +69504,17 @@ Possible Types
-
+
-
+
-
+
@@ -70512,7 +69525,7 @@ Possible Types
Example
{
- "redirect_code": 123,
+ "redirect_code": 987,
"relative_url": "abc123",
"type": "CMS_PAGE"
}
@@ -70565,7 +69578,7 @@ Fields
Example
{
- "redirect_code": 123,
+ "redirect_code": 987,
"relative_url": "xyz789",
"type": "CMS_PAGE"
}
@@ -70613,8 +69626,8 @@ Fields
Example
{
- "name": "abc123",
- "value": "abc123"
+ "name": "xyz789",
+ "value": "xyz789"
}
@@ -70661,7 +69674,7 @@ Fields
Example
{
"message": "xyz789",
- "timestamp": "abc123"
+ "timestamp": "xyz789"
}
@@ -70766,7 +69779,7 @@ Fields
Example
- {"current_page": 987, "page_size": 987, "total_pages": 987}
+ {"current_page": 987, "page_size": 123, "total_pages": 123}
@@ -70805,7 +69818,7 @@ Fields
Example
- {"search": "xyz789"}
+ {"search": "abc123"}
@@ -70867,10 +69880,10 @@ Fields
Example
{
- "id": 123,
- "label": "xyz789",
- "type": "abc123",
- "uid": 4,
+ "id": 987,
+ "label": "abc123",
+ "type": "xyz789",
+ "uid": "4",
"values": [SelectedBundleOptionValue]
}
@@ -70944,11 +69957,11 @@ Fields
Example
{
"id": 123,
- "label": "abc123",
+ "label": "xyz789",
"original_price": Money,
"price": 123.45,
"priceV2": Money,
- "quantity": 987.65,
+ "quantity": 123.45,
"uid": 4
}
@@ -71021,9 +70034,9 @@ Example
{
"configurable_product_option_uid": 4,
"configurable_product_option_value_uid": "4",
- "id": 123,
- "option_label": "abc123",
- "value_id": 987,
+ "id": 987,
+ "option_label": "xyz789",
+ "value_id": 123,
"value_label": "abc123"
}
@@ -71146,11 +70159,11 @@ Fields
Example
{
- "customizable_option_uid": 4,
+ "customizable_option_uid": "4",
"id": 987,
- "is_required": true,
+ "is_required": false,
"label": "abc123",
- "sort_order": 123,
+ "sort_order": 987,
"type": "abc123",
"values": [SelectedCustomizableOptionValue]
}
@@ -71216,7 +70229,7 @@ Fields
Example
{
"customizable_option_value_uid": 4,
- "id": 987,
+ "id": 123,
"label": "xyz789",
"price": CartItemSelectedOptionValuePrice,
"value": "abc123"
@@ -71271,8 +70284,8 @@ Fields
Example
{
"code": "xyz789",
- "purchase_order_number": "abc123",
- "title": "abc123"
+ "purchase_order_number": "xyz789",
+ "title": "xyz789"
}
@@ -71352,7 +70365,7 @@ Example
{
"amount": Money,
"base_amount": Money,
- "carrier_code": "abc123",
+ "carrier_code": "xyz789",
"carrier_title": "xyz789",
"method_code": "xyz789",
"method_title": "abc123",
@@ -71411,7 +70424,7 @@ Fields
Example
{
- "product_id": 987,
+ "product_id": 123,
"recipients": [SendEmailToFriendRecipientInput],
"sender": SendEmailToFriendSenderInput
}
@@ -71555,7 +70568,7 @@ Fields
Example
{
- "email": "xyz789",
+ "email": "abc123",
"name": "xyz789"
}
@@ -71710,7 +70723,7 @@ Fields
Example
- {"enabled_for_customers": false, "enabled_for_guests": false}
+ {"enabled_for_customers": true, "enabled_for_guests": true}
@@ -71846,7 +70859,7 @@ Fields
Example
{
"billing_address": BillingAddressInput,
- "cart_id": "xyz789"
+ "cart_id": "abc123"
}
@@ -71887,50 +70900,6 @@ Fields
Example
{"cart": Cart}
-
-
-
-
-
-
-
- Types
-
- SetCartAsInactiveOutput
-
-
-
- Description
- Sets the cart as inactive
-
-
-
-
-
- Example
- {"error": "xyz789", "success": true}
@@ -71998,7 +70967,7 @@ Example
"cart_id": "abc123",
"gift_message": GiftMessageInput,
"gift_receipt_included": false,
- "gift_wrapping_id": 4,
+ "gift_wrapping_id": "4",
"printed_card_included": false
}
@@ -72086,8 +71055,8 @@ Fields
Example
{
- "cart_id": "abc123",
- "email": "abc123"
+ "cart_id": "xyz789",
+ "email": "xyz789"
}
@@ -72214,7 +71183,7 @@ Fields
Example
{
"billing_address": NegotiableQuoteBillingAddressInput,
- "quote_uid": "4"
+ "quote_uid": 4
}
@@ -72302,7 +71271,7 @@ Fields
Example
{
"payment_method": NegotiableQuotePaymentMethodInput,
- "quote_uid": "4"
+ "quote_uid": 4
}
@@ -72395,7 +71364,7 @@ Fields
Example
{
- "customer_address_id": 4,
+ "customer_address_id": "4",
"quote_uid": "4",
"shipping_addresses": [
NegotiableQuoteShippingAddressInput
@@ -72672,7 +71641,7 @@ Fields
Example
{
- "cart_id": "xyz789",
+ "cart_id": "abc123",
"payment_method": PaymentMethodInput
}
@@ -72760,7 +71729,7 @@ Fields
Example
{
- "cart_id": "xyz789",
+ "cart_id": "abc123",
"shipping_addresses": [ShippingAddressInput]
}
@@ -72848,7 +71817,7 @@ Fields
Example
{
- "cart_id": "abc123",
+ "cart_id": "xyz789",
"shipping_methods": [ShippingMethodInput]
}
@@ -72937,7 +71906,7 @@ Fields
Example
{
"email": "xyz789",
- "name": "abc123"
+ "name": "xyz789"
}
@@ -72977,7 +71946,7 @@ Fields
Example
- {"is_shared": true}
+ {"is_shared": false}
@@ -73139,8 +72108,8 @@ Example
"order_item": OrderItemInterface,
"product_name": "abc123",
"product_sale_price": Money,
- "product_sku": "abc123",
- "quantity_shipped": 987.65
+ "product_sku": "xyz789",
+ "quantity_shipped": 123.45
}
@@ -73290,8 +72259,8 @@ Fields
Example
{
"carrier": "abc123",
- "number": "abc123",
- "title": "abc123"
+ "number": "xyz789",
+ "title": "xyz789"
}
@@ -73331,12 +72300,6 @@ Fields
An ID from the customer's address book that uniquely identifies the address to be used for shipping.
-
-
- customer_address_uid - ID
-
- The unique ID from the customer's address book that uniquely identifies the address to be used for shipping.
-
customer_notes - String
@@ -73358,10 +72321,9 @@ Fields
Example
{
"address": CartAddressInput,
- "customer_address_id": 987,
- "customer_address_uid": "4",
- "customer_notes": "abc123",
- "pickup_location_code": "abc123"
+ "customer_address_id": 123,
+ "customer_notes": "xyz789",
+ "pickup_location_code": "xyz789"
}
@@ -73426,11 +72388,6 @@ Fields
The custom attribute values of the billing or shipping address.
-
- customer_address_uid - ID
-
- The unique ID from the customer's address book that uniquely identifies the address.
-
customer_notes - String
@@ -73447,10 +72404,9 @@ Fields
The first name of the customer or guest.
- id - Int
-
- Id of the customer address. Use customer_address_uid instead.
+ id - Int
+ Id of the customer address.
items_weight - Float
@@ -73516,9 +72472,9 @@ Fields
The telephone number for the billing or shipping address.
- uid - ID!
+ uid - String!
- The unique id of the customer cart address.
+ The unique id of the customer address.
vat_id - String
@@ -73540,24 +72496,23 @@ Example
"company": "abc123",
"country": CartAddressCountry,
"custom_attributes": [AttributeValueInterface],
- "customer_address_uid": "4",
"customer_notes": "xyz789",
"fax": "xyz789",
"firstname": "xyz789",
"id": 987,
- "items_weight": 123.45,
- "lastname": "abc123",
- "middlename": "abc123",
+ "items_weight": 987.65,
+ "lastname": "xyz789",
+ "middlename": "xyz789",
"pickup_location_code": "abc123",
- "postcode": "xyz789",
+ "postcode": "abc123",
"prefix": "xyz789",
"region": CartAddressRegion,
"same_as_billing": true,
"selected_shipping_method": SelectedShippingMethod,
- "street": ["xyz789"],
- "suffix": "abc123",
+ "street": ["abc123"],
+ "suffix": "xyz789",
"telephone": "abc123",
- "uid": 4,
+ "uid": "xyz789",
"vat_id": "abc123"
}
@@ -73710,7 +72665,7 @@ Fields
Example
{
- "carrier_code": "abc123",
+ "carrier_code": "xyz789",
"method_code": "xyz789"
}
@@ -73840,17 +72795,17 @@ Example
"errors": [CartItemError],
"gift_message": GiftMessage,
"gift_wrapping": GiftWrapping,
- "id": "xyz789",
- "is_available": true,
- "max_qty": 987.65,
+ "id": "abc123",
+ "is_available": false,
+ "max_qty": 123.45,
"min_qty": 987.65,
- "not_available_message": "xyz789",
+ "not_available_message": "abc123",
"note_from_buyer": [ItemNote],
"note_from_seller": [ItemNote],
"prices": CartItemPrices,
"product": ProductInterface,
- "quantity": 987.65,
- "uid": "4"
+ "quantity": 123.45,
+ "uid": 4
}
@@ -74216,6 +73171,11 @@ currentPage
+
+ rules - [CatalogRule]
+
+ Provides applied catalog rules in the current active cart
+
sale - Int
@@ -74396,88 +73356,89 @@ currentPage
Example
{
- "activity": "abc123",
- "attribute_set_id": 123,
- "canonical_url": "abc123",
+ "activity": "xyz789",
+ "attribute_set_id": 987,
+ "canonical_url": "xyz789",
"categories": [CategoryInterface],
- "category_gear": "abc123",
- "climate": "abc123",
- "collar": "xyz789",
- "color": 987,
+ "category_gear": "xyz789",
+ "climate": "xyz789",
+ "collar": "abc123",
+ "color": 123,
"country_of_manufacture": "xyz789",
- "created_at": "xyz789",
+ "created_at": "abc123",
"crosssell_products": [ProductInterface],
"custom_attributesV2": ProductCustomAttributes,
"description": ComplexTextValue,
"eco_collection": 123,
- "erin_recommends": 987,
- "features_bags": "xyz789",
- "format": 123,
+ "erin_recommends": 123,
+ "features_bags": "abc123",
+ "format": 987,
"gender": "abc123",
"gift_message_available": false,
- "gift_wrapping_available": true,
+ "gift_wrapping_available": false,
"gift_wrapping_price": Money,
- "id": 123,
+ "id": 987,
"image": ProductImage,
- "is_returnable": "xyz789",
+ "is_returnable": "abc123",
"manufacturer": 987,
"material": "xyz789",
- "max_sale_qty": 123.45,
+ "max_sale_qty": 987.65,
"media_gallery": [MediaGalleryInterface],
"media_gallery_entries": [MediaGalleryEntry],
"meta_description": "abc123",
"meta_keyword": "abc123",
"meta_title": "xyz789",
- "min_sale_qty": 123.45,
+ "min_sale_qty": 987.65,
"name": "xyz789",
"new": 123,
"new_from_date": "abc123",
- "new_to_date": "xyz789",
- "only_x_left_in_stock": 987.65,
+ "new_to_date": "abc123",
+ "only_x_left_in_stock": 123.45,
"options": [CustomizableOptionInterface],
"options_container": "xyz789",
- "pattern": "xyz789",
+ "pattern": "abc123",
"performance_fabric": 123,
"price": ProductPrices,
"price_range": PriceRange,
"price_tiers": [TierPrice],
"product_links": [ProductLinksInterface],
"purpose": 987,
- "quantity": 123.45,
+ "quantity": 987.65,
"rating_summary": 987.65,
"redirect_code": 123,
"related_products": [ProductInterface],
"relative_url": "abc123",
"review_count": 987,
"reviews": ProductReviews,
- "sale": 987,
+ "rules": [CatalogRule],
+ "sale": 123,
"short_description": ComplexTextValue,
- "size": 987,
- "sku": "xyz789",
+ "size": 123,
+ "sku": "abc123",
"sleeve": "abc123",
"small_image": ProductImage,
- "special_from_date": "abc123",
+ "special_from_date": "xyz789",
"special_price": 123.45,
"special_to_date": "abc123",
"staged": false,
"stock_status": "IN_STOCK",
"strap_bags": "xyz789",
- "style_bags": "xyz789",
+ "style_bags": "abc123",
"style_bottom": "abc123",
- "style_general": "abc123",
+ "style_general": "xyz789",
"swatch_image": "xyz789",
"thumbnail": ProductImage,
"tier_price": 987.65,
"tier_prices": [ProductTierPrices],
"type": "CMS_PAGE",
- "type_id": "abc123",
+ "type_id": "xyz789",
"uid": 4,
"updated_at": "xyz789",
"upsell_products": [ProductInterface],
- "url_key": "xyz789",
+ "url_key": "abc123",
"url_path": "abc123",
"url_rewrites": [UrlRewrite],
- "url_suffix": "xyz789",
+ "url_suffix": "abc123",
"websites": [Website],
"weight": 123.45
}
@@ -74586,8 +73547,8 @@ Example
{
"customizable_options": [SelectedCustomizableOption],
"product": ProductInterface,
- "quantity": 987.65,
- "uid": 4
+ "quantity": 123.45,
+ "uid": "4"
}
@@ -74653,12 +73614,12 @@ Fields
Example
{
- "added_at": "xyz789",
+ "added_at": "abc123",
"customizable_options": [SelectedCustomizableOption],
- "description": "xyz789",
- "id": "4",
+ "description": "abc123",
+ "id": 4,
"product": ProductInterface,
- "quantity": 987.65
+ "quantity": 123.45
}
@@ -74713,8 +73674,8 @@ Fields
Example
{
"payment_source": "xyz789",
- "payments_order_id": "abc123",
- "paypal_order_id": "xyz789"
+ "payments_order_id": "xyz789",
+ "paypal_order_id": "abc123"
}
@@ -74738,11 +73699,6 @@ Fields
-
- app_switch_when_available - Boolean
-
- Indicated whether to use App Switch on enabled mobile devices
-
button_styles - ButtonStyles
@@ -74801,12 +73757,11 @@ Fields
Example
{
- "app_switch_when_available": false,
"button_styles": ButtonStyles,
- "code": "xyz789",
+ "code": "abc123",
"display_message": false,
"display_venmo": true,
- "is_visible": true,
+ "is_visible": false,
"message_styles": MessageStyles,
"payment_intent": "xyz789",
"sdk_params": [SDKParams],
@@ -74905,7 +73860,7 @@ Fields
Example
{
- "label": "xyz789",
+ "label": "abc123",
"value": "xyz789"
}
@@ -74952,7 +73907,7 @@ Fields
Example
{
- "default": "xyz789",
+ "default": "abc123",
"options": [SortField]
}
@@ -75711,11 +74666,6 @@ Fields
Indicates if gift wrapping prices are displayed on the Shopping Cart page. Possible values: 1 (Yes) and 0 (No).
-
- cart_merge_preference - String!
-
- Configuration data from checkout/cart/cart_merge_preference
-
cart_printed_card - String
@@ -75938,7 +74888,12 @@ Fields
The landing page that is associated with the base URL.
- graphql_share_customer_group - Boolean
+ graphql_share_all_customer_groups - Boolean!
+
+ Configuration data from customer/account_information/graphql_share_all_customer_groups
+
+
+ graphql_share_customer_group - Boolean!
Configuration data from customer/account_information/graphql_share_customer_group
@@ -76296,14 +75251,24 @@ Fields
Email to a Friend configuration.
- share_active_segments - Boolean
+ share_all_catalog_rules - Boolean!
+
+ Configuration data from catalog/rule/share_all_catalog_rules
+
+
+ share_all_sales_rule - Boolean!
+
+ Configuration data from promo/graphql/share_all_sales_rule
+
+
+ share_applied_catalog_rules - Boolean!
- Configuration data from customer/magento_customersegment/share_active_segments
+ Configuration data from catalog/rule/share_applied_catalog_rules
- share_applied_cart_rule - Boolean
+ share_applied_sales_rule - Boolean!
- Configuration data from promo/graphql/share_applied_cart_rule
+ Configuration data from promo/graphql/share_applied_sales_rule
shopping_cart_display_full_summary - Boolean
@@ -76464,41 +75429,41 @@ Fields
Example
{
- "absolute_footer": "abc123",
- "allow_gift_receipt": "abc123",
+ "absolute_footer": "xyz789",
+ "allow_gift_receipt": "xyz789",
"allow_gift_wrapping_on_order": "abc123",
- "allow_gift_wrapping_on_order_items": "abc123",
- "allow_guests_to_write_product_reviews": "xyz789",
- "allow_items": "abc123",
+ "allow_gift_wrapping_on_order_items": "xyz789",
+ "allow_guests_to_write_product_reviews": "abc123",
+ "allow_items": "xyz789",
"allow_order": "abc123",
- "allow_printed_card": "xyz789",
- "autocomplete_on_storefront": true,
+ "allow_printed_card": "abc123",
+ "autocomplete_on_storefront": false,
"base_currency_code": "xyz789",
"base_link_url": "xyz789",
"base_media_url": "abc123",
"base_static_url": "xyz789",
- "base_url": "xyz789",
- "braintree_3dsecure_allowspecific": true,
+ "base_url": "abc123",
+ "braintree_3dsecure_allowspecific": false,
"braintree_3dsecure_always_request_3ds": false,
"braintree_3dsecure_specificcountry": "abc123",
"braintree_3dsecure_threshold_amount": "abc123",
- "braintree_3dsecure_verify_3dsecure": false,
+ "braintree_3dsecure_verify_3dsecure": true,
"braintree_ach_direct_debit_vault_active": true,
- "braintree_applepay_merchant_name": "abc123",
+ "braintree_applepay_merchant_name": "xyz789",
"braintree_applepay_vault_active": false,
"braintree_cc_vault_active": "abc123",
"braintree_cc_vault_cvv": true,
"braintree_environment": "xyz789",
- "braintree_googlepay_btn_color": "abc123",
+ "braintree_googlepay_btn_color": "xyz789",
"braintree_googlepay_cctypes": "xyz789",
"braintree_googlepay_merchant_id": "xyz789",
- "braintree_googlepay_vault_active": true,
+ "braintree_googlepay_vault_active": false,
"braintree_local_payment_allowed_methods": "xyz789",
"braintree_local_payment_fallback_button_text": "abc123",
- "braintree_local_payment_redirect_on_fail": "abc123",
- "braintree_merchant_account_id": "abc123",
+ "braintree_local_payment_redirect_on_fail": "xyz789",
+ "braintree_merchant_account_id": "xyz789",
"braintree_paypal_button_location_cart_type_credit_color": "xyz789",
- "braintree_paypal_button_location_cart_type_credit_label": "abc123",
+ "braintree_paypal_button_location_cart_type_credit_label": "xyz789",
"braintree_paypal_button_location_cart_type_credit_shape": "abc123",
"braintree_paypal_button_location_cart_type_credit_show": true,
"braintree_paypal_button_location_cart_type_messaging_layout": "abc123",
@@ -76507,150 +75472,150 @@ Example
"braintree_paypal_button_location_cart_type_messaging_show": true,
"braintree_paypal_button_location_cart_type_messaging_text_color": "xyz789",
"braintree_paypal_button_location_cart_type_paylater_color": "xyz789",
- "braintree_paypal_button_location_cart_type_paylater_label": "abc123",
+ "braintree_paypal_button_location_cart_type_paylater_label": "xyz789",
"braintree_paypal_button_location_cart_type_paylater_shape": "abc123",
"braintree_paypal_button_location_cart_type_paylater_show": true,
- "braintree_paypal_button_location_cart_type_paypal_color": "xyz789",
- "braintree_paypal_button_location_cart_type_paypal_label": "xyz789",
+ "braintree_paypal_button_location_cart_type_paypal_color": "abc123",
+ "braintree_paypal_button_location_cart_type_paypal_label": "abc123",
"braintree_paypal_button_location_cart_type_paypal_shape": "abc123",
- "braintree_paypal_button_location_cart_type_paypal_show": false,
- "braintree_paypal_button_location_checkout_type_credit_color": "abc123",
- "braintree_paypal_button_location_checkout_type_credit_label": "xyz789",
- "braintree_paypal_button_location_checkout_type_credit_shape": "abc123",
+ "braintree_paypal_button_location_cart_type_paypal_show": true,
+ "braintree_paypal_button_location_checkout_type_credit_color": "xyz789",
+ "braintree_paypal_button_location_checkout_type_credit_label": "abc123",
+ "braintree_paypal_button_location_checkout_type_credit_shape": "xyz789",
"braintree_paypal_button_location_checkout_type_credit_show": false,
- "braintree_paypal_button_location_checkout_type_messaging_layout": "xyz789",
- "braintree_paypal_button_location_checkout_type_messaging_logo": "xyz789",
+ "braintree_paypal_button_location_checkout_type_messaging_layout": "abc123",
+ "braintree_paypal_button_location_checkout_type_messaging_logo": "abc123",
"braintree_paypal_button_location_checkout_type_messaging_logo_position": "xyz789",
- "braintree_paypal_button_location_checkout_type_messaging_show": true,
+ "braintree_paypal_button_location_checkout_type_messaging_show": false,
"braintree_paypal_button_location_checkout_type_messaging_text_color": "abc123",
"braintree_paypal_button_location_checkout_type_paylater_color": "xyz789",
- "braintree_paypal_button_location_checkout_type_paylater_label": "abc123",
+ "braintree_paypal_button_location_checkout_type_paylater_label": "xyz789",
"braintree_paypal_button_location_checkout_type_paylater_shape": "xyz789",
"braintree_paypal_button_location_checkout_type_paylater_show": false,
"braintree_paypal_button_location_checkout_type_paypal_color": "xyz789",
"braintree_paypal_button_location_checkout_type_paypal_label": "xyz789",
- "braintree_paypal_button_location_checkout_type_paypal_shape": "abc123",
+ "braintree_paypal_button_location_checkout_type_paypal_shape": "xyz789",
"braintree_paypal_button_location_checkout_type_paypal_show": true,
- "braintree_paypal_button_location_productpage_type_credit_color": "abc123",
+ "braintree_paypal_button_location_productpage_type_credit_color": "xyz789",
"braintree_paypal_button_location_productpage_type_credit_label": "abc123",
- "braintree_paypal_button_location_productpage_type_credit_shape": "xyz789",
+ "braintree_paypal_button_location_productpage_type_credit_shape": "abc123",
"braintree_paypal_button_location_productpage_type_credit_show": false,
- "braintree_paypal_button_location_productpage_type_messaging_layout": "abc123",
+ "braintree_paypal_button_location_productpage_type_messaging_layout": "xyz789",
"braintree_paypal_button_location_productpage_type_messaging_logo": "abc123",
"braintree_paypal_button_location_productpage_type_messaging_logo_position": "xyz789",
- "braintree_paypal_button_location_productpage_type_messaging_show": true,
- "braintree_paypal_button_location_productpage_type_messaging_text_color": "xyz789",
+ "braintree_paypal_button_location_productpage_type_messaging_show": false,
+ "braintree_paypal_button_location_productpage_type_messaging_text_color": "abc123",
"braintree_paypal_button_location_productpage_type_paylater_color": "abc123",
- "braintree_paypal_button_location_productpage_type_paylater_label": "abc123",
+ "braintree_paypal_button_location_productpage_type_paylater_label": "xyz789",
"braintree_paypal_button_location_productpage_type_paylater_shape": "abc123",
- "braintree_paypal_button_location_productpage_type_paylater_show": true,
+ "braintree_paypal_button_location_productpage_type_paylater_show": false,
"braintree_paypal_button_location_productpage_type_paypal_color": "abc123",
"braintree_paypal_button_location_productpage_type_paypal_label": "abc123",
- "braintree_paypal_button_location_productpage_type_paypal_shape": "abc123",
- "braintree_paypal_button_location_productpage_type_paypal_show": false,
+ "braintree_paypal_button_location_productpage_type_paypal_shape": "xyz789",
+ "braintree_paypal_button_location_productpage_type_paypal_show": true,
"braintree_paypal_credit_uk_merchant_name": "abc123",
- "braintree_paypal_display_on_shopping_cart": true,
- "braintree_paypal_merchant_country": "abc123",
+ "braintree_paypal_display_on_shopping_cart": false,
+ "braintree_paypal_merchant_country": "xyz789",
"braintree_paypal_merchant_name_override": "xyz789",
- "braintree_paypal_require_billing_address": true,
+ "braintree_paypal_require_billing_address": false,
"braintree_paypal_send_cart_line_items": true,
"braintree_paypal_vault_active": false,
- "cart_expires_in_days": 123,
- "cart_gift_wrapping": "abc123",
- "cart_merge_preference": "abc123",
- "cart_printed_card": "abc123",
- "cart_summary_display_quantity": 987,
- "catalog_default_sort_by": "xyz789",
+ "cart_expires_in_days": 987,
+ "cart_gift_wrapping": "xyz789",
+ "cart_printed_card": "xyz789",
+ "cart_summary_display_quantity": 123,
+ "catalog_default_sort_by": "abc123",
"category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
"category_url_suffix": "xyz789",
- "check_money_order_enable_for_specific_countries": true,
+ "check_money_order_enable_for_specific_countries": false,
"check_money_order_enabled": false,
"check_money_order_make_check_payable_to": "xyz789",
"check_money_order_max_order_total": "abc123",
"check_money_order_min_order_total": "xyz789",
- "check_money_order_new_order_status": "abc123",
- "check_money_order_payment_from_specific_countries": "abc123",
+ "check_money_order_new_order_status": "xyz789",
+ "check_money_order_payment_from_specific_countries": "xyz789",
"check_money_order_send_check_to": "abc123",
"check_money_order_sort_order": 987,
- "check_money_order_title": "abc123",
- "cms_home_page": "abc123",
- "cms_no_cookies": "abc123",
- "cms_no_route": "abc123",
+ "check_money_order_title": "xyz789",
+ "cms_home_page": "xyz789",
+ "cms_no_cookies": "xyz789",
+ "cms_no_route": "xyz789",
"code": "xyz789",
"configurable_product_image": "ITSELF",
"configurable_thumbnail_source": "abc123",
- "contact_enabled": false,
+ "contact_enabled": true,
"copyright": "xyz789",
- "countries_with_required_region": "abc123",
+ "countries_with_required_region": "xyz789",
"create_account_confirmation": true,
"customer_access_token_lifetime": 987.65,
- "default_country": "abc123",
- "default_description": "xyz789",
+ "default_country": "xyz789",
+ "default_description": "abc123",
"default_display_currency_code": "abc123",
- "default_keywords": "abc123",
- "default_title": "abc123",
- "demonotice": 987,
+ "default_keywords": "xyz789",
+ "default_title": "xyz789",
+ "demonotice": 123,
"display_product_prices_in_catalog": 123,
- "display_shipping_prices": 123,
- "display_state_if_optional": true,
- "enable_multiple_wishlists": "xyz789",
+ "display_shipping_prices": 987,
+ "display_state_if_optional": false,
+ "enable_multiple_wishlists": "abc123",
"fixed_product_taxes_apply_tax_to_fpt": false,
- "fixed_product_taxes_display_prices_in_emails": 123,
+ "fixed_product_taxes_display_prices_in_emails": 987,
"fixed_product_taxes_display_prices_in_product_lists": 123,
"fixed_product_taxes_display_prices_in_sales_modules": 987,
"fixed_product_taxes_display_prices_on_product_view_page": 987,
"fixed_product_taxes_enable": true,
"fixed_product_taxes_include_fpt_in_subtotal": true,
- "front": "xyz789",
- "graphql_share_customer_group": true,
- "grid_per_page": 123,
- "grid_per_page_values": "abc123",
+ "front": "abc123",
+ "graphql_share_all_customer_groups": true,
+ "graphql_share_customer_group": false,
+ "grid_per_page": 987,
+ "grid_per_page_values": "xyz789",
"grouped_product_image": "ITSELF",
"head_includes": "abc123",
- "head_shortcut_icon": "abc123",
+ "head_shortcut_icon": "xyz789",
"header_logo_src": "xyz789",
- "id": 123,
- "is_checkout_agreements_enabled": false,
- "is_default_store": true,
- "is_default_store_group": false,
+ "id": 987,
+ "is_checkout_agreements_enabled": true,
+ "is_default_store": false,
+ "is_default_store_group": true,
"is_guest_checkout_enabled": true,
"is_negotiable_quote_active": false,
- "is_one_page_checkout_enabled": false,
- "is_requisition_list_active": "abc123",
+ "is_one_page_checkout_enabled": true,
+ "is_requisition_list_active": "xyz789",
"list_mode": "xyz789",
- "list_per_page": 987,
- "list_per_page_values": "abc123",
- "locale": "abc123",
+ "list_per_page": 123,
+ "list_per_page_values": "xyz789",
+ "locale": "xyz789",
"logo_alt": "xyz789",
"logo_height": 123,
- "logo_width": 123,
- "magento_reward_general_is_enabled": "abc123",
- "magento_reward_general_is_enabled_on_front": "xyz789",
+ "logo_width": 987,
+ "magento_reward_general_is_enabled": "xyz789",
+ "magento_reward_general_is_enabled_on_front": "abc123",
"magento_reward_general_min_points_balance": "xyz789",
- "magento_reward_general_publish_history": "xyz789",
+ "magento_reward_general_publish_history": "abc123",
"magento_reward_points_invitation_customer": "xyz789",
- "magento_reward_points_invitation_customer_limit": "xyz789",
+ "magento_reward_points_invitation_customer_limit": "abc123",
"magento_reward_points_invitation_order": "xyz789",
- "magento_reward_points_invitation_order_limit": "xyz789",
+ "magento_reward_points_invitation_order_limit": "abc123",
"magento_reward_points_newsletter": "abc123",
- "magento_reward_points_order": "abc123",
+ "magento_reward_points_order": "xyz789",
"magento_reward_points_register": "xyz789",
"magento_reward_points_review": "abc123",
"magento_reward_points_review_limit": "xyz789",
- "magento_wishlist_general_is_enabled": "abc123",
- "max_items_in_order_summary": 987,
- "maximum_number_of_wishlists": "xyz789",
+ "magento_wishlist_general_is_enabled": "xyz789",
+ "max_items_in_order_summary": 123,
+ "maximum_number_of_wishlists": "abc123",
"minicart_display": false,
"minicart_max_items": 123,
- "minimum_password_length": "xyz789",
+ "minimum_password_length": "abc123",
"newsletter_enabled": true,
"no_route": "xyz789",
- "optional_zip_countries": "abc123",
- "order_cancellation_enabled": false,
+ "optional_zip_countries": "xyz789",
+ "order_cancellation_enabled": true,
"order_cancellation_reasons": [CancellationReason],
"orders_invoices_credit_memos_display_full_summary": false,
"orders_invoices_credit_memos_display_grandtotal": false,
- "orders_invoices_credit_memos_display_price": 987,
+ "orders_invoices_credit_memos_display_price": 123,
"orders_invoices_credit_memos_display_shipping_amount": 987,
"orders_invoices_credit_memos_display_subtotal": 987,
"orders_invoices_credit_memos_display_zero_tax": true,
@@ -76658,47 +75623,49 @@ Example
"printed_card_price": "abc123",
"printed_card_priceV2": Money,
"product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
- "product_reviews_enabled": "xyz789",
- "product_url_suffix": "abc123",
- "quickorder_active": true,
+ "product_reviews_enabled": "abc123",
+ "product_url_suffix": "xyz789",
+ "quickorder_active": false,
"required_character_classes_number": "xyz789",
- "returns_enabled": "abc123",
+ "returns_enabled": "xyz789",
"root_category_id": 123,
"root_category_uid": "4",
"sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
"sales_gift_wrapping": "xyz789",
"sales_printed_card": "xyz789",
"secure_base_link_url": "abc123",
- "secure_base_media_url": "abc123",
- "secure_base_static_url": "xyz789",
+ "secure_base_media_url": "xyz789",
+ "secure_base_static_url": "abc123",
"secure_base_url": "abc123",
"send_friend": SendFriendConfiguration,
- "share_active_segments": true,
- "share_applied_cart_rule": true,
- "shopping_cart_display_full_summary": false,
- "shopping_cart_display_grand_total": false,
+ "share_all_catalog_rules": false,
+ "share_all_sales_rule": true,
+ "share_applied_catalog_rules": true,
+ "share_applied_sales_rule": false,
+ "shopping_cart_display_full_summary": true,
+ "shopping_cart_display_grand_total": true,
"shopping_cart_display_price": 987,
- "shopping_cart_display_shipping": 123,
+ "shopping_cart_display_shipping": 987,
"shopping_cart_display_subtotal": 123,
"shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX",
"shopping_cart_display_zero_tax": true,
"show_cms_breadcrumbs": 987,
- "store_code": "4",
+ "store_code": 4,
"store_group_code": "4",
- "store_group_name": "abc123",
- "store_name": "xyz789",
- "store_sort_order": 987,
+ "store_group_name": "xyz789",
+ "store_name": "abc123",
+ "store_sort_order": 123,
"timezone": "abc123",
"title_prefix": "xyz789",
"title_separator": "xyz789",
"title_suffix": "xyz789",
"use_store_in_url": true,
- "website_code": "4",
- "website_id": 123,
+ "website_code": 4,
+ "website_id": 987,
"website_name": "xyz789",
- "weight_unit": "abc123",
+ "weight_unit": "xyz789",
"welcome": "abc123",
- "zero_subtotal_enable_for_specific_countries": true,
+ "zero_subtotal_enable_for_specific_countries": false,
"zero_subtotal_enabled": false,
"zero_subtotal_new_order_status": "xyz789",
"zero_subtotal_payment_action": "xyz789",
@@ -76765,9 +75732,9 @@ Fields
Example
{
- "position": 987,
+ "position": 123,
"use_in_layered_navigation": "NO",
- "use_in_product_listing": false,
+ "use_in_product_listing": true,
"use_in_search_results_layered_navigation": true,
"visible_on_catalog_pages": true
}
@@ -76862,10 +75829,10 @@ Fields
Example
{
- "comment": "abc123",
+ "comment": "xyz789",
"max_order_commitment": 123,
"min_order_commitment": 987,
- "name": "abc123",
+ "name": "xyz789",
"reference_document_links": [
NegotiableQuoteTemplateReferenceDocumentLinkInput
],
@@ -77016,8 +75983,8 @@ Fields
Example
{
- "type": "abc123",
- "value": "abc123"
+ "type": "xyz789",
+ "value": "xyz789"
}
@@ -77080,7 +76047,7 @@ Possible Types
Example
- {"value": "xyz789"}
+ {"value": "abc123"}
@@ -77397,7 +76364,7 @@ Fields
Example
{
- "cartId": "abc123",
+ "cartId": "xyz789",
"id": "abc123"
}
@@ -77450,8 +76417,8 @@ Fields
Example
{
"amount": Money,
- "rate": 123.45,
- "title": "xyz789"
+ "rate": 987.65,
+ "title": "abc123"
}
@@ -77645,7 +76612,7 @@ Example
{
"discount": ProductDiscount,
"final_price": Money,
- "quantity": 123.45
+ "quantity": 987.65
}
@@ -77693,7 +76660,7 @@ Fields
Example
{
- "cart_id": "abc123",
+ "cart_id": "xyz789",
"cart_items": [CartItemUpdateInput]
}
@@ -78012,7 +76979,7 @@ Example
GiftRegistryDynamicAttributeInput
],
"event_name": "abc123",
- "message": "xyz789",
+ "message": "abc123",
"privacy_settings": "PRIVATE",
"shipping_address": GiftRegistryShippingAddressInput,
"status": "ACTIVE"
@@ -78069,9 +77036,9 @@ Fields
Example
{
- "gift_registry_item_uid": "4",
+ "gift_registry_item_uid": 4,
"note": "xyz789",
- "quantity": 123.45
+ "quantity": 987.65
}
@@ -78219,9 +77186,9 @@ Example
GiftRegistryDynamicAttributeInput
],
"email": "abc123",
- "firstname": "xyz789",
+ "firstname": "abc123",
"gift_registry_registrant_uid": "4",
- "lastname": "abc123"
+ "lastname": "xyz789"
}
@@ -78436,7 +77403,7 @@ Fields
Example
{
"items": [NegotiableQuoteTemplateItemQuantityInput],
- "template_id": "4"
+ "template_id": 4
}
@@ -78561,11 +77528,11 @@ Fields
Example
{
- "applies_to": ["4"],
+ "applies_to": [4],
"approvers": [4],
"condition": CreatePurchaseOrderApprovalRuleConditionInput,
"description": "xyz789",
- "name": "abc123",
+ "name": "xyz789",
"status": "ENABLED",
"uid": 4
}
@@ -78615,7 +77582,7 @@ Fields
Example
{
- "description": "abc123",
+ "description": "xyz789",
"name": "abc123"
}
@@ -78678,7 +77645,7 @@ Example
{
"entered_options": [EnteredOptionInput],
"item_id": "4",
- "quantity": 987.65,
+ "quantity": 123.45,
"selected_options": ["xyz789"]
}
@@ -78808,7 +77775,7 @@ Fields
Example
{
- "name": "xyz789",
+ "name": "abc123",
"uid": 4,
"visibility": "PUBLIC"
}
@@ -78857,7 +77824,7 @@ Fields
Example
{
"parameters": [HttpQueryParameter],
- "url": "xyz789"
+ "url": "abc123"
}
@@ -79021,7 +77988,7 @@ Fields
Example
{
- "currentPage": 123,
+ "currentPage": 987,
"pageSize": 123,
"sort": [CompaniesSortInput]
}
@@ -79558,10 +78525,10 @@ Fields
Example
{
- "payment_source": "abc123",
- "payments_order_id": "abc123",
- "paypal_order_id": "abc123",
- "public_hash": "xyz789"
+ "payment_source": "xyz789",
+ "payments_order_id": "xyz789",
+ "paypal_order_id": "xyz789",
+ "public_hash": "abc123"
}
@@ -79642,7 +78609,7 @@ Fields
Example
- {"public_hash": "abc123"}
+ {"public_hash": "xyz789"}
@@ -79753,10 +78720,10 @@ Example
"discount": [Discount],
"errors": [CartItemError],
"id": "xyz789",
- "is_available": true,
- "max_qty": 987.65,
- "min_qty": 987.65,
- "not_available_message": "xyz789",
+ "is_available": false,
+ "max_qty": 123.45,
+ "min_qty": 123.45,
+ "not_available_message": "abc123",
"note_from_buyer": [ItemNote],
"note_from_seller": [ItemNote],
"prices": CartItemPrices,
@@ -80128,6 +79095,11 @@ currentPage
+
+ rules - [CatalogRule]
+
+ Provides applied catalog rules in the current active cart
+
sale - Int
@@ -80304,46 +79276,46 @@ currentPageExample
{
"activity": "abc123",
- "attribute_set_id": 987,
+ "attribute_set_id": 123,
"canonical_url": "abc123",
"categories": [CategoryInterface],
- "category_gear": "xyz789",
+ "category_gear": "abc123",
"climate": "abc123",
"collar": "xyz789",
- "color": 987,
- "country_of_manufacture": "abc123",
+ "color": 123,
+ "country_of_manufacture": "xyz789",
"created_at": "xyz789",
"crosssell_products": [ProductInterface],
"custom_attributesV2": ProductCustomAttributes,
"description": ComplexTextValue,
- "eco_collection": 123,
+ "eco_collection": 987,
"erin_recommends": 987,
"features_bags": "xyz789",
"format": 987,
"gender": "abc123",
- "gift_message_available": false,
+ "gift_message_available": true,
"gift_wrapping_available": false,
"gift_wrapping_price": Money,
"id": 123,
"image": ProductImage,
"is_returnable": "abc123",
"manufacturer": 987,
- "material": "abc123",
- "max_sale_qty": 987.65,
+ "material": "xyz789",
+ "max_sale_qty": 123.45,
"media_gallery": [MediaGalleryInterface],
"media_gallery_entries": [MediaGalleryEntry],
- "meta_description": "xyz789",
+ "meta_description": "abc123",
"meta_keyword": "abc123",
"meta_title": "xyz789",
"min_sale_qty": 987.65,
"name": "xyz789",
"new": 987,
"new_from_date": "abc123",
- "new_to_date": "abc123",
+ "new_to_date": "xyz789",
"only_x_left_in_stock": 123.45,
"options": [CustomizableOptionInterface],
- "options_container": "xyz789",
- "pattern": "abc123",
+ "options_container": "abc123",
+ "pattern": "xyz789",
"performance_fabric": 987,
"price": ProductPrices,
"price_range": PriceRange,
@@ -80355,20 +79327,21 @@ Example
"redirect_code": 987,
"related_products": [ProductInterface],
"relative_url": "abc123",
- "review_count": 123,
+ "review_count": 987,
"reviews": ProductReviews,
+ "rules": [CatalogRule],
"sale": 987,
"short_description": ComplexTextValue,
"size": 123,
- "sku": "xyz789",
+ "sku": "abc123",
"sleeve": "xyz789",
"small_image": ProductImage,
"special_from_date": "xyz789",
"special_price": 987.65,
- "special_to_date": "abc123",
+ "special_to_date": "xyz789",
"staged": true,
"stock_status": "IN_STOCK",
- "strap_bags": "abc123",
+ "strap_bags": "xyz789",
"style_bags": "xyz789",
"style_bottom": "xyz789",
"style_general": "abc123",
@@ -80378,8 +79351,8 @@ Example
"tier_prices": [ProductTierPrices],
"type": "CMS_PAGE",
"type_id": "xyz789",
- "uid": 4,
- "updated_at": "abc123",
+ "uid": "4",
+ "updated_at": "xyz789",
"upsell_products": [ProductInterface],
"url_key": "xyz789",
"url_path": "xyz789",
@@ -80493,7 +79466,7 @@ Example
"customizable_options": [SelectedCustomizableOption],
"product": ProductInterface,
"quantity": 123.45,
- "uid": 4
+ "uid": "4"
}
@@ -80561,7 +79534,7 @@ Example
{
"added_at": "abc123",
"customizable_options": [SelectedCustomizableOption],
- "description": "abc123",
+ "description": "xyz789",
"id": "4",
"product": ProductInterface,
"quantity": 987.65
@@ -80641,7 +79614,7 @@ Example
"id": 123,
"is_default": true,
"name": "xyz789",
- "sort_order": 123
+ "sort_order": 987
}
@@ -80835,9 +79808,9 @@ Example
"items": [WishlistItem],
"items_count": 987,
"items_v2": WishlistItems,
- "name": "xyz789",
- "sharing_code": "abc123",
- "updated_at": "xyz789",
+ "name": "abc123",
+ "sharing_code": "xyz789",
+ "updated_at": "abc123",
"visibility": "PUBLIC"
}
@@ -80895,8 +79868,8 @@ Fields
Example
{
"code": "PRODUCT_NOT_FOUND",
- "message": "xyz789",
- "wishlistId": 4,
+ "message": "abc123",
+ "wishlistId": "4",
"wishlistItemId": 4
}
@@ -80932,13 +79905,6 @@ Values
-
-
- REQUIRED_PARAMETER_MISSING
-
-
-
-
NOT_SALABLE
@@ -81029,9 +79995,9 @@ Example
{
"added_at": "xyz789",
"description": "xyz789",
- "id": 123,
+ "id": 987,
"product": ProductInterface,
- "qty": 987.65
+ "qty": 123.45
}
@@ -81147,10 +80113,10 @@ Fields
Example
{
"entered_options": [EnteredOptionInput],
- "parent_sku": "abc123",
- "quantity": 123.45,
- "selected_options": [4],
- "sku": "abc123"
+ "parent_sku": "xyz789",
+ "quantity": 987.65,
+ "selected_options": ["4"],
+ "sku": "xyz789"
}
@@ -81237,12 +80203,12 @@ Possible Types
-
+
-
+
@@ -81263,12 +80229,12 @@ Possible Types
Example
{
- "added_at": "xyz789",
+ "added_at": "abc123",
"customizable_options": [SelectedCustomizableOption],
- "description": "abc123",
- "id": 4,
+ "description": "xyz789",
+ "id": "4",
"product": ProductInterface,
- "quantity": 987.65
+ "quantity": 123.45
}
@@ -81315,7 +80281,10 @@ Fields
Example
- {"quantity": 123.45, "wishlist_item_id": 4}
+ {
+ "quantity": 987.65,
+ "wishlist_item_id": "4"
+}
@@ -81380,10 +80349,10 @@ Fields
Example
{
- "description": "abc123",
+ "description": "xyz789",
"entered_options": [EnteredOptionInput],
"quantity": 987.65,
- "selected_options": ["4"],
+ "selected_options": [4],
"wishlist_item_id": "4"
}
@@ -81498,10 +80467,10 @@ Fields
Example
{
"items": [WishlistItem],
- "items_count": 987,
+ "items_count": 123,
"name": "xyz789",
"sharing_code": "abc123",
- "updated_at": "xyz789"
+ "updated_at": "abc123"
}
@@ -81590,7 +80559,7 @@ Fields
Example
- {"cart_id": "xyz789"}
+ {"cart_id": "abc123"}
diff --git a/static/graphql-api/2.4.9-beta-1/javascripts/spectaql.min.js b/static/graphql-api/2.4.8/javascripts/spectaql.min.js
similarity index 100%
rename from static/graphql-api/2.4.9-beta-1/javascripts/spectaql.min.js
rename to static/graphql-api/2.4.8/javascripts/spectaql.min.js
diff --git a/static/graphql-api/2.4.9-beta-1/stylesheets/spectaql.min.css b/static/graphql-api/2.4.8/stylesheets/spectaql.min.css
similarity index 100%
rename from static/graphql-api/2.4.9-beta-1/stylesheets/spectaql.min.css
rename to static/graphql-api/2.4.8/stylesheets/spectaql.min.css
diff --git a/static/graphql-api/index.html b/static/graphql-api/index.html
index a284d836c..fd1f636b8 100644
--- a/static/graphql-api/index.html
+++ b/static/graphql-api/index.html
@@ -57,8 +57,10 @@
customer
customerCart
customerDownloadableProducts
+ customerGroup
customerOrders
customerPaymentTokens
+ customerSegments
dynamicBlocks
getHostedProUrl
getPayflowLinkToken
@@ -107,6 +109,7 @@
addGiftRegistryRegistrants
addProductsToCart
addProductsToCompareList
+ addProductsToNewCart
addProductsToRequisitionList
addProductsToWishlist
addPurchaseOrderComment
@@ -131,7 +134,9 @@
changeCustomerPassword
clearCart
clearCustomerCart
+ clearWishlist
closeNegotiableQuotes
+ completeOrder
confirmCancelOrder
confirmEmail
confirmReturn
@@ -168,6 +173,7 @@
deleteCompareList
deleteCustomer
deleteCustomerAddress
+ deleteCustomerAddressV2
deleteNegotiableQuoteTemplate
deleteNegotiableQuotes
deletePaymentToken
@@ -178,6 +184,7 @@
duplicateNegotiableQuote
estimateShippingMethods
estimateTotals
+ exchangeExternalCustomerToken
generateCustomerToken
generateCustomerTokenAsAdmin
generateNegotiableQuoteFromTemplate
@@ -222,6 +229,7 @@
sendEmailToFriend
sendNegotiableQuoteForReview
setBillingAddressOnCart
+ setCartAsInactive
setGiftOptionsOnCart
setGuestEmailOnCart
setLineItemNote
@@ -239,7 +247,6 @@
submitNegotiableQuoteTemplateForReview
subscribeEmailToNewsletter
syncPaymentOrder
- trackViewedProduct
updateCartItems
updateCompany
updateCompanyRole
@@ -248,6 +255,7 @@
updateCompanyUser
updateCustomer
updateCustomerAddress
+ updateCustomerAddressV2
updateCustomerEmail
updateCustomerV2
updateGiftRegistry
@@ -280,6 +288,7 @@ Types
AddGiftRegistryRegistrantsOutput
AddProductsToCartOutput
AddProductsToCompareListInput
+ AddProductsToNewCartOutput
AddProductsToRequisitionListOutput
AddProductsToWishlistOutput
AddPurchaseOrderCommentInput
@@ -390,13 +399,12 @@ Types
CartItemUpdateInput
CartItems
CartPrices
- CartRule
+ CartRuleStorefront
CartTaxItem
CartUserInputError
CartUserInputErrorType
CatalogAttributeApplyToEnum
CatalogAttributeMetadata
- CatalogRule
CategoryFilterInput
CategoryInterface
CategoryProducts
@@ -445,6 +453,7 @@ Types
CompanyRoleUpdateInput
CompanyRoles
CompanySalesRepresentative
+ CompanyStatusEnum
CompanyStructure
CompanyStructureEntity
CompanyStructureItem
@@ -461,6 +470,7 @@ Types
ComparableAttribute
ComparableItem
CompareList
+ CompleteOrderInput
ComplexTextValue
ConfigurableAttributeOption
ConfigurableCartItem
@@ -533,7 +543,7 @@ Types
CustomerCreateInput
CustomerDownloadableProduct
CustomerDownloadableProducts
- CustomerGroup
+ CustomerGroupStorefront
CustomerInput
CustomerOrder
CustomerOrderSortInput
@@ -542,8 +552,7 @@ Types
CustomerOrdersFilterInput
CustomerOutput
CustomerPaymentTokens
- CustomerSegment
- CustomerSegmentApplyTo
+ CustomerSegmentStorefront
CustomerStoreCredit
CustomerStoreCreditHistory
CustomerStoreCreditHistoryItem
@@ -616,7 +625,11 @@ Types
EstimateAddressInput
EstimateTotalsInput
EstimateTotalsOutput
+ ExchangeExternalCustomerTokenInput
+ ExchangeExternalCustomerTokenOutput
ExchangeRate
+ FastlaneConfig
+ FastlaneMethodInput
FilterEqualTypeInput
FilterMatchTypeEnum
FilterMatchTypeInput
@@ -645,6 +658,7 @@ Types
GiftCardShipmentItem
GiftCardTypeEnum
GiftCardWishlistItem
+ GiftCartAttributeValue
GiftMessage
GiftMessageInput
GiftOptionsPrices
@@ -677,6 +691,7 @@ Types
GroupedProductItem
GroupedProductWishlistItem
GuestOrderCancelInput
+ GuestOrderInformationInput
HostedFieldsConfig
HostedFieldsInput
HostedProInput
@@ -766,7 +781,6 @@ Types
OrderActionType
OrderAddress
OrderCustomerInfo
- OrderInformationInput
OrderItem
OrderItemInterface
OrderItemOption
@@ -917,6 +931,7 @@ Types
RequisitionList
RequisitionListFilterInput
RequisitionListItemInterface
+ RequisitionListItems
RequisitionListItemsInput
RequisitionLists
RequistionListItems
@@ -969,6 +984,7 @@ Types
SendNegotiableQuoteForReviewOutput
SetBillingAddressOnCartInput
SetBillingAddressOnCartOutput
+ SetCartAsInactiveOutput
SetGiftOptionsOnCartInput
SetGiftOptionsOnCartOutput
SetGuestEmailOnCartInput
@@ -1120,7 +1136,7 @@ Headers
Version
- 2.4.8
+ 2.4.9
@@ -1437,6 +1453,7 @@ Query
braintree_paypal_vault_active
cart_expires_in_days
cart_gift_wrapping
+ cart_merge_preference
cart_printed_card
cart_summary_display_quantity
catalog_default_sort_by
@@ -1481,7 +1498,6 @@ Query
fixed_product_taxes_enable
fixed_product_taxes_include_fpt_in_subtotal
front
- graphql_share_all_customer_groups
graphql_share_customer_group
grid_per_page
grid_per_page_values
@@ -1559,10 +1575,8 @@ Query
send_friend {
...SendFriendConfigurationFragment
}
- share_all_catalog_rules
- share_all_sales_rule
- share_applied_catalog_rules
- share_applied_sales_rule
+ share_active_segments
+ share_applied_cart_rule
shopping_cart_display_full_summary
shopping_cart_display_grand_total
shopping_cart_display_price
@@ -1599,7 +1613,7 @@ Query
Variables
- {"useCurrentGroup": false}
+ {"useCurrentGroup": true}
@@ -1609,116 +1623,117 @@ Response
"availableStores": [
{
"absolute_footer": "abc123",
- "allow_gift_receipt": "xyz789",
- "allow_gift_wrapping_on_order": "xyz789",
- "allow_gift_wrapping_on_order_items": "xyz789",
- "allow_guests_to_write_product_reviews": "xyz789",
- "allow_items": "abc123",
+ "allow_gift_receipt": "abc123",
+ "allow_gift_wrapping_on_order": "abc123",
+ "allow_gift_wrapping_on_order_items": "abc123",
+ "allow_guests_to_write_product_reviews": "abc123",
+ "allow_items": "xyz789",
"allow_order": "xyz789",
- "allow_printed_card": "abc123",
- "autocomplete_on_storefront": true,
+ "allow_printed_card": "xyz789",
+ "autocomplete_on_storefront": false,
"base_currency_code": "abc123",
"base_link_url": "abc123",
- "base_media_url": "xyz789",
- "base_static_url": "xyz789",
+ "base_media_url": "abc123",
+ "base_static_url": "abc123",
"base_url": "xyz789",
"braintree_3dsecure_allowspecific": true,
- "braintree_3dsecure_always_request_3ds": false,
+ "braintree_3dsecure_always_request_3ds": true,
"braintree_3dsecure_specificcountry": "xyz789",
- "braintree_3dsecure_threshold_amount": "xyz789",
+ "braintree_3dsecure_threshold_amount": "abc123",
"braintree_3dsecure_verify_3dsecure": false,
- "braintree_ach_direct_debit_vault_active": false,
+ "braintree_ach_direct_debit_vault_active": true,
"braintree_applepay_merchant_name": "xyz789",
"braintree_applepay_vault_active": false,
"braintree_cc_vault_active": "xyz789",
"braintree_cc_vault_cvv": false,
- "braintree_environment": "xyz789",
+ "braintree_environment": "abc123",
"braintree_googlepay_btn_color": "xyz789",
"braintree_googlepay_cctypes": "xyz789",
- "braintree_googlepay_merchant_id": "abc123",
+ "braintree_googlepay_merchant_id": "xyz789",
"braintree_googlepay_vault_active": false,
- "braintree_local_payment_allowed_methods": "abc123",
+ "braintree_local_payment_allowed_methods": "xyz789",
"braintree_local_payment_fallback_button_text": "abc123",
- "braintree_local_payment_redirect_on_fail": "xyz789",
+ "braintree_local_payment_redirect_on_fail": "abc123",
"braintree_merchant_account_id": "abc123",
- "braintree_paypal_button_location_cart_type_credit_color": "xyz789",
- "braintree_paypal_button_location_cart_type_credit_label": "abc123",
+ "braintree_paypal_button_location_cart_type_credit_color": "abc123",
+ "braintree_paypal_button_location_cart_type_credit_label": "xyz789",
"braintree_paypal_button_location_cart_type_credit_shape": "xyz789",
"braintree_paypal_button_location_cart_type_credit_show": true,
- "braintree_paypal_button_location_cart_type_messaging_layout": "abc123",
- "braintree_paypal_button_location_cart_type_messaging_logo": "xyz789",
- "braintree_paypal_button_location_cart_type_messaging_logo_position": "abc123",
- "braintree_paypal_button_location_cart_type_messaging_show": true,
- "braintree_paypal_button_location_cart_type_messaging_text_color": "abc123",
+ "braintree_paypal_button_location_cart_type_messaging_layout": "xyz789",
+ "braintree_paypal_button_location_cart_type_messaging_logo": "abc123",
+ "braintree_paypal_button_location_cart_type_messaging_logo_position": "xyz789",
+ "braintree_paypal_button_location_cart_type_messaging_show": false,
+ "braintree_paypal_button_location_cart_type_messaging_text_color": "xyz789",
"braintree_paypal_button_location_cart_type_paylater_color": "abc123",
"braintree_paypal_button_location_cart_type_paylater_label": "xyz789",
- "braintree_paypal_button_location_cart_type_paylater_shape": "xyz789",
+ "braintree_paypal_button_location_cart_type_paylater_shape": "abc123",
"braintree_paypal_button_location_cart_type_paylater_show": false,
- "braintree_paypal_button_location_cart_type_paypal_color": "xyz789",
+ "braintree_paypal_button_location_cart_type_paypal_color": "abc123",
"braintree_paypal_button_location_cart_type_paypal_label": "xyz789",
- "braintree_paypal_button_location_cart_type_paypal_shape": "xyz789",
+ "braintree_paypal_button_location_cart_type_paypal_shape": "abc123",
"braintree_paypal_button_location_cart_type_paypal_show": true,
"braintree_paypal_button_location_checkout_type_credit_color": "abc123",
"braintree_paypal_button_location_checkout_type_credit_label": "xyz789",
"braintree_paypal_button_location_checkout_type_credit_shape": "abc123",
"braintree_paypal_button_location_checkout_type_credit_show": false,
- "braintree_paypal_button_location_checkout_type_messaging_layout": "xyz789",
- "braintree_paypal_button_location_checkout_type_messaging_logo": "xyz789",
+ "braintree_paypal_button_location_checkout_type_messaging_layout": "abc123",
+ "braintree_paypal_button_location_checkout_type_messaging_logo": "abc123",
"braintree_paypal_button_location_checkout_type_messaging_logo_position": "abc123",
- "braintree_paypal_button_location_checkout_type_messaging_show": true,
- "braintree_paypal_button_location_checkout_type_messaging_text_color": "abc123",
- "braintree_paypal_button_location_checkout_type_paylater_color": "xyz789",
- "braintree_paypal_button_location_checkout_type_paylater_label": "xyz789",
+ "braintree_paypal_button_location_checkout_type_messaging_show": false,
+ "braintree_paypal_button_location_checkout_type_messaging_text_color": "xyz789",
+ "braintree_paypal_button_location_checkout_type_paylater_color": "abc123",
+ "braintree_paypal_button_location_checkout_type_paylater_label": "abc123",
"braintree_paypal_button_location_checkout_type_paylater_shape": "abc123",
- "braintree_paypal_button_location_checkout_type_paylater_show": true,
+ "braintree_paypal_button_location_checkout_type_paylater_show": false,
"braintree_paypal_button_location_checkout_type_paypal_color": "abc123",
- "braintree_paypal_button_location_checkout_type_paypal_label": "abc123",
+ "braintree_paypal_button_location_checkout_type_paypal_label": "xyz789",
"braintree_paypal_button_location_checkout_type_paypal_shape": "xyz789",
"braintree_paypal_button_location_checkout_type_paypal_show": true,
"braintree_paypal_button_location_productpage_type_credit_color": "abc123",
- "braintree_paypal_button_location_productpage_type_credit_label": "xyz789",
- "braintree_paypal_button_location_productpage_type_credit_shape": "abc123",
- "braintree_paypal_button_location_productpage_type_credit_show": true,
- "braintree_paypal_button_location_productpage_type_messaging_layout": "xyz789",
+ "braintree_paypal_button_location_productpage_type_credit_label": "abc123",
+ "braintree_paypal_button_location_productpage_type_credit_shape": "xyz789",
+ "braintree_paypal_button_location_productpage_type_credit_show": false,
+ "braintree_paypal_button_location_productpage_type_messaging_layout": "abc123",
"braintree_paypal_button_location_productpage_type_messaging_logo": "abc123",
- "braintree_paypal_button_location_productpage_type_messaging_logo_position": "abc123",
+ "braintree_paypal_button_location_productpage_type_messaging_logo_position": "xyz789",
"braintree_paypal_button_location_productpage_type_messaging_show": true,
"braintree_paypal_button_location_productpage_type_messaging_text_color": "abc123",
- "braintree_paypal_button_location_productpage_type_paylater_color": "xyz789",
- "braintree_paypal_button_location_productpage_type_paylater_label": "abc123",
+ "braintree_paypal_button_location_productpage_type_paylater_color": "abc123",
+ "braintree_paypal_button_location_productpage_type_paylater_label": "xyz789",
"braintree_paypal_button_location_productpage_type_paylater_shape": "abc123",
- "braintree_paypal_button_location_productpage_type_paylater_show": false,
+ "braintree_paypal_button_location_productpage_type_paylater_show": true,
"braintree_paypal_button_location_productpage_type_paypal_color": "xyz789",
"braintree_paypal_button_location_productpage_type_paypal_label": "xyz789",
"braintree_paypal_button_location_productpage_type_paypal_shape": "abc123",
"braintree_paypal_button_location_productpage_type_paypal_show": true,
- "braintree_paypal_credit_uk_merchant_name": "abc123",
+ "braintree_paypal_credit_uk_merchant_name": "xyz789",
"braintree_paypal_display_on_shopping_cart": false,
- "braintree_paypal_merchant_country": "abc123",
- "braintree_paypal_merchant_name_override": "xyz789",
+ "braintree_paypal_merchant_country": "xyz789",
+ "braintree_paypal_merchant_name_override": "abc123",
"braintree_paypal_require_billing_address": true,
- "braintree_paypal_send_cart_line_items": false,
- "braintree_paypal_vault_active": true,
+ "braintree_paypal_send_cart_line_items": true,
+ "braintree_paypal_vault_active": false,
"cart_expires_in_days": 123,
- "cart_gift_wrapping": "abc123",
- "cart_printed_card": "xyz789",
- "cart_summary_display_quantity": 987,
+ "cart_gift_wrapping": "xyz789",
+ "cart_merge_preference": "abc123",
+ "cart_printed_card": "abc123",
+ "cart_summary_display_quantity": 123,
"catalog_default_sort_by": "abc123",
"category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
"category_url_suffix": "xyz789",
- "check_money_order_enable_for_specific_countries": true,
+ "check_money_order_enable_for_specific_countries": false,
"check_money_order_enabled": false,
"check_money_order_make_check_payable_to": "abc123",
"check_money_order_max_order_total": "xyz789",
"check_money_order_min_order_total": "abc123",
- "check_money_order_new_order_status": "xyz789",
+ "check_money_order_new_order_status": "abc123",
"check_money_order_payment_from_specific_countries": "abc123",
"check_money_order_send_check_to": "abc123",
- "check_money_order_sort_order": 987,
- "check_money_order_title": "abc123",
- "cms_home_page": "xyz789",
+ "check_money_order_sort_order": 123,
+ "check_money_order_title": "xyz789",
+ "cms_home_page": "abc123",
"cms_no_cookies": "xyz789",
- "cms_no_route": "abc123",
+ "cms_no_route": "xyz789",
"code": "abc123",
"configurable_product_image": "ITSELF",
"configurable_thumbnail_source": "abc123",
@@ -1727,131 +1742,128 @@ Response
"countries_with_required_region": "abc123",
"create_account_confirmation": false,
"customer_access_token_lifetime": 123.45,
- "default_country": "xyz789",
- "default_description": "abc123",
+ "default_country": "abc123",
+ "default_description": "xyz789",
"default_display_currency_code": "xyz789",
"default_keywords": "xyz789",
- "default_title": "xyz789",
+ "default_title": "abc123",
"demonotice": 123,
"display_product_prices_in_catalog": 123,
- "display_shipping_prices": 123,
+ "display_shipping_prices": 987,
"display_state_if_optional": false,
"enable_multiple_wishlists": "xyz789",
"fixed_product_taxes_apply_tax_to_fpt": false,
"fixed_product_taxes_display_prices_in_emails": 123,
"fixed_product_taxes_display_prices_in_product_lists": 987,
"fixed_product_taxes_display_prices_in_sales_modules": 123,
- "fixed_product_taxes_display_prices_on_product_view_page": 123,
+ "fixed_product_taxes_display_prices_on_product_view_page": 987,
"fixed_product_taxes_enable": true,
- "fixed_product_taxes_include_fpt_in_subtotal": false,
+ "fixed_product_taxes_include_fpt_in_subtotal": true,
"front": "xyz789",
- "graphql_share_all_customer_groups": false,
"graphql_share_customer_group": false,
- "grid_per_page": 123,
- "grid_per_page_values": "xyz789",
+ "grid_per_page": 987,
+ "grid_per_page_values": "abc123",
"grouped_product_image": "ITSELF",
- "head_includes": "xyz789",
+ "head_includes": "abc123",
"head_shortcut_icon": "abc123",
- "header_logo_src": "abc123",
- "id": 987,
+ "header_logo_src": "xyz789",
+ "id": 123,
"is_checkout_agreements_enabled": false,
"is_default_store": true,
- "is_default_store_group": true,
+ "is_default_store_group": false,
"is_guest_checkout_enabled": true,
"is_negotiable_quote_active": true,
- "is_one_page_checkout_enabled": true,
- "is_requisition_list_active": "xyz789",
+ "is_one_page_checkout_enabled": false,
+ "is_requisition_list_active": "abc123",
"list_mode": "xyz789",
- "list_per_page": 987,
- "list_per_page_values": "xyz789",
+ "list_per_page": 123,
+ "list_per_page_values": "abc123",
"locale": "abc123",
- "logo_alt": "xyz789",
- "logo_height": 987,
+ "logo_alt": "abc123",
+ "logo_height": 123,
"logo_width": 123,
- "magento_reward_general_is_enabled": "xyz789",
+ "magento_reward_general_is_enabled": "abc123",
"magento_reward_general_is_enabled_on_front": "abc123",
"magento_reward_general_min_points_balance": "xyz789",
- "magento_reward_general_publish_history": "abc123",
- "magento_reward_points_invitation_customer": "abc123",
+ "magento_reward_general_publish_history": "xyz789",
+ "magento_reward_points_invitation_customer": "xyz789",
"magento_reward_points_invitation_customer_limit": "xyz789",
"magento_reward_points_invitation_order": "xyz789",
"magento_reward_points_invitation_order_limit": "xyz789",
"magento_reward_points_newsletter": "xyz789",
- "magento_reward_points_order": "abc123",
+ "magento_reward_points_order": "xyz789",
"magento_reward_points_register": "abc123",
"magento_reward_points_review": "xyz789",
- "magento_reward_points_review_limit": "abc123",
- "magento_wishlist_general_is_enabled": "xyz789",
- "max_items_in_order_summary": 123,
+ "magento_reward_points_review_limit": "xyz789",
+ "magento_wishlist_general_is_enabled": "abc123",
+ "max_items_in_order_summary": 987,
"maximum_number_of_wishlists": "xyz789",
- "minicart_display": false,
- "minicart_max_items": 987,
- "minimum_password_length": "xyz789",
- "newsletter_enabled": false,
+ "minicart_display": true,
+ "minicart_max_items": 123,
+ "minimum_password_length": "abc123",
+ "newsletter_enabled": true,
"no_route": "xyz789",
"optional_zip_countries": "abc123",
"order_cancellation_enabled": false,
"order_cancellation_reasons": [
CancellationReason
],
- "orders_invoices_credit_memos_display_full_summary": false,
+ "orders_invoices_credit_memos_display_full_summary": true,
"orders_invoices_credit_memos_display_grandtotal": false,
- "orders_invoices_credit_memos_display_price": 123,
- "orders_invoices_credit_memos_display_shipping_amount": 987,
+ "orders_invoices_credit_memos_display_price": 987,
+ "orders_invoices_credit_memos_display_shipping_amount": 123,
"orders_invoices_credit_memos_display_subtotal": 123,
"orders_invoices_credit_memos_display_zero_tax": true,
- "payment_payflowpro_cc_vault_active": "xyz789",
+ "payment_payflowpro_cc_vault_active": "abc123",
"printed_card_price": "abc123",
"printed_card_priceV2": Money,
"product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
- "product_reviews_enabled": "abc123",
- "product_url_suffix": "abc123",
- "quickorder_active": true,
+ "product_reviews_enabled": "xyz789",
+ "product_url_suffix": "xyz789",
+ "quickorder_active": false,
"required_character_classes_number": "xyz789",
"returns_enabled": "xyz789",
- "root_category_id": 123,
- "root_category_uid": 4,
+ "root_category_id": 987,
+ "root_category_uid": "4",
"sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
- "sales_gift_wrapping": "abc123",
- "sales_printed_card": "xyz789",
- "secure_base_link_url": "abc123",
+ "sales_gift_wrapping": "xyz789",
+ "sales_printed_card": "abc123",
+ "secure_base_link_url": "xyz789",
"secure_base_media_url": "abc123",
- "secure_base_static_url": "xyz789",
+ "secure_base_static_url": "abc123",
"secure_base_url": "xyz789",
"send_friend": SendFriendConfiguration,
- "share_all_catalog_rules": false,
- "share_all_sales_rule": false,
- "share_applied_catalog_rules": true,
- "share_applied_sales_rule": true,
- "shopping_cart_display_full_summary": false,
- "shopping_cart_display_grand_total": true,
+ "share_active_segments": true,
+ "share_applied_cart_rule": true,
+ "shopping_cart_display_full_summary": true,
+ "shopping_cart_display_grand_total": false,
"shopping_cart_display_price": 123,
"shopping_cart_display_shipping": 123,
"shopping_cart_display_subtotal": 987,
"shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX",
- "shopping_cart_display_zero_tax": true,
- "show_cms_breadcrumbs": 987,
- "store_code": "4",
+ "shopping_cart_display_zero_tax": false,
+ "show_cms_breadcrumbs": 123,
+ "store_code": 4,
"store_group_code": "4",
"store_group_name": "xyz789",
"store_name": "abc123",
- "store_sort_order": 987,
+ "store_sort_order": 123,
"timezone": "abc123",
"title_prefix": "xyz789",
- "title_separator": "xyz789",
+ "title_separator": "abc123",
"title_suffix": "abc123",
"use_store_in_url": false,
- "website_code": "4",
+ "website_code": 4,
"website_id": 987,
"website_name": "abc123",
- "weight_unit": "xyz789",
+ "weight_unit": "abc123",
"welcome": "xyz789",
- "zero_subtotal_enable_for_specific_countries": true,
+ "zero_subtotal_enable_for_specific_countries": false,
"zero_subtotal_enabled": true,
- "zero_subtotal_new_order_status": "abc123",
- "zero_subtotal_payment_action": "xyz789",
- "zero_subtotal_payment_from_specific_countries": "abc123",
- "zero_subtotal_sort_order": 123,
+ "zero_subtotal_new_order_status": "xyz789",
+ "zero_subtotal_payment_action": "abc123",
+ "zero_subtotal_payment_from_specific_countries": "xyz789",
+ "zero_subtotal_sort_order": 987,
"zero_subtotal_title": "abc123"
}
]
@@ -1956,7 +1968,7 @@ Query
}
printed_card_included
rules {
- ...CartRuleFragment
+ ...CartRuleStorefrontFragment
}
selected_payment_method {
...SelectedPaymentMethodFragment
@@ -1971,7 +1983,7 @@ Query
Variables
- {"cart_id": "abc123"}
+ {"cart_id": "xyz789"}
@@ -1991,15 +2003,15 @@ Response
"billing_address": BillingCartAddress,
"email": "abc123",
"gift_message": GiftMessage,
- "gift_receipt_included": true,
+ "gift_receipt_included": false,
"gift_wrapping": GiftWrapping,
"id": "4",
- "is_virtual": true,
+ "is_virtual": false,
"items": [CartItemInterface],
"itemsV2": CartItems,
"prices": CartPrices,
"printed_card_included": false,
- "rules": [CartRule],
+ "rules": [CartRuleStorefront],
"selected_payment_method": SelectedPaymentMethod,
"shipping_addresses": [ShippingCartAddress],
"total_quantity": 123.45
@@ -2223,7 +2235,7 @@ Query
Variables
- {"id": 123}
+ {"id": 987}
@@ -2231,43 +2243,43 @@ Response
{
"data": {
"category": {
- "automatic_sorting": "xyz789",
- "available_sort_by": ["abc123"],
+ "automatic_sorting": "abc123",
+ "available_sort_by": ["xyz789"],
"breadcrumbs": [Breadcrumb],
- "canonical_url": "xyz789",
+ "canonical_url": "abc123",
"children": [CategoryTree],
- "children_count": "xyz789",
+ "children_count": "abc123",
"cms_block": CmsBlock,
"created_at": "xyz789",
"custom_layout_update_file": "xyz789",
- "default_sort_by": "abc123",
+ "default_sort_by": "xyz789",
"description": "xyz789",
"display_mode": "xyz789",
"filter_price_range": 987.65,
"id": 987,
"image": "abc123",
- "include_in_menu": 123,
+ "include_in_menu": 987,
"is_anchor": 987,
- "landing_page": 987,
+ "landing_page": 123,
"level": 987,
- "meta_description": "abc123",
+ "meta_description": "xyz789",
"meta_keywords": "xyz789",
"meta_title": "xyz789",
"name": "xyz789",
"path": "xyz789",
- "path_in_store": "xyz789",
+ "path_in_store": "abc123",
"position": 987,
"product_count": 987,
"products": CategoryProducts,
- "redirect_code": 123,
- "relative_url": "abc123",
- "staged": true,
+ "redirect_code": 987,
+ "relative_url": "xyz789",
+ "staged": false,
"type": "CMS_PAGE",
- "uid": "4",
- "updated_at": "xyz789",
- "url_key": "abc123",
+ "uid": 4,
+ "updated_at": "abc123",
+ "url_key": "xyz789",
"url_path": "xyz789",
- "url_suffix": "xyz789"
+ "url_suffix": "abc123"
}
}
}
@@ -2416,32 +2428,32 @@ Response
"data": {
"categoryList": [
{
- "automatic_sorting": "xyz789",
- "available_sort_by": ["xyz789"],
+ "automatic_sorting": "abc123",
+ "available_sort_by": ["abc123"],
"breadcrumbs": [Breadcrumb],
"canonical_url": "abc123",
"children": [CategoryTree],
"children_count": "xyz789",
"cms_block": CmsBlock,
"created_at": "xyz789",
- "custom_layout_update_file": "abc123",
+ "custom_layout_update_file": "xyz789",
"default_sort_by": "xyz789",
- "description": "xyz789",
- "display_mode": "xyz789",
- "filter_price_range": 123.45,
- "id": 987,
+ "description": "abc123",
+ "display_mode": "abc123",
+ "filter_price_range": 987.65,
+ "id": 123,
"image": "xyz789",
"include_in_menu": 123,
- "is_anchor": 123,
- "landing_page": 987,
- "level": 987,
+ "is_anchor": 987,
+ "landing_page": 123,
+ "level": 123,
"meta_description": "abc123",
- "meta_keywords": "xyz789",
- "meta_title": "abc123",
+ "meta_keywords": "abc123",
+ "meta_title": "xyz789",
"name": "abc123",
"path": "xyz789",
"path_in_store": "xyz789",
- "position": 987,
+ "position": 123,
"product_count": 123,
"products": CategoryProducts,
"redirect_code": 987,
@@ -2449,9 +2461,9 @@ Response
"staged": true,
"type": "CMS_PAGE",
"uid": "4",
- "updated_at": "xyz789",
+ "updated_at": "abc123",
"url_key": "abc123",
- "url_path": "xyz789",
+ "url_path": "abc123",
"url_suffix": "xyz789"
}
]
@@ -2509,10 +2521,10 @@ Response
"data": {
"checkoutAgreements": [
{
- "agreement_id": 987,
- "checkbox_text": "abc123",
+ "agreement_id": 123,
+ "checkbox_text": "xyz789",
"content": "xyz789",
- "content_height": "abc123",
+ "content_height": "xyz789",
"is_html": false,
"mode": "AUTO",
"name": "xyz789"
@@ -2673,7 +2685,7 @@ Query
Variables
- {"id": 987, "identifier": "abc123"}
+ {"id": 123, "identifier": "abc123"}
@@ -2683,12 +2695,12 @@ Response
"cmsPage": {
"content": "xyz789",
"content_heading": "abc123",
- "identifier": "abc123",
- "meta_description": "xyz789",
- "meta_keywords": "xyz789",
- "meta_title": "abc123",
+ "identifier": "xyz789",
+ "meta_description": "abc123",
+ "meta_keywords": "abc123",
+ "meta_title": "xyz789",
"page_layout": "xyz789",
- "redirect_code": 123,
+ "redirect_code": 987,
"relative_url": "abc123",
"title": "xyz789",
"type": "CMS_PAGE",
@@ -2788,10 +2800,10 @@ Response
"credit": CompanyCredit,
"credit_history": CompanyCreditHistory,
"email": "abc123",
- "id": 4,
+ "id": "4",
"legal_address": CompanyLegalAddress,
"legal_name": "xyz789",
- "name": "xyz789",
+ "name": "abc123",
"payment_methods": ["abc123"],
"reseller_id": "xyz789",
"role": CompanyRole,
@@ -2873,7 +2885,7 @@ Query
Variables
- {"uid": 4}
+ {"uid": "4"}
@@ -2882,9 +2894,9 @@ Response
"data": {
"compareList": {
"attributes": [ComparableAttribute],
- "item_count": 123,
+ "item_count": 987,
"items": [ComparableItem],
- "uid": 4
+ "uid": "4"
}
}
}
@@ -2944,8 +2956,8 @@ Response
"available_regions": [Region],
"full_name_english": "xyz789",
"full_name_locale": "abc123",
- "id": "xyz789",
- "three_letter_abbreviation": "abc123",
+ "id": "abc123",
+ "three_letter_abbreviation": "xyz789",
"two_letter_abbreviation": "xyz789"
}
]
@@ -3020,7 +3032,7 @@ Query
Variables
- {"id": "xyz789"}
+ {"id": "abc123"}
@@ -3029,10 +3041,10 @@ Response
"data": {
"country": {
"available_regions": [Region],
- "full_name_english": "abc123",
- "full_name_locale": "abc123",
- "id": "xyz789",
- "three_letter_abbreviation": "abc123",
+ "full_name_english": "xyz789",
+ "full_name_locale": "xyz789",
+ "id": "abc123",
+ "three_letter_abbreviation": "xyz789",
"two_letter_abbreviation": "xyz789"
}
}
@@ -3094,10 +3106,10 @@ Response
"available_currency_codes": [
"abc123"
],
- "base_currency_code": "abc123",
- "base_currency_symbol": "abc123",
+ "base_currency_code": "xyz789",
+ "base_currency_symbol": "xyz789",
"default_display_currecy_code": "xyz789",
- "default_display_currecy_symbol": "abc123",
+ "default_display_currecy_symbol": "xyz789",
"default_display_currency_code": "abc123",
"default_display_currency_symbol": "abc123",
"exchange_rates": [ExchangeRate]
@@ -3331,7 +3343,7 @@ Query
...GiftRegistryFragment
}
group {
- ...CustomerGroupFragment
+ ...CustomerGroupStorefrontFragment
}
group_id
id
@@ -3378,7 +3390,7 @@ Query
...CompanyRoleFragment
}
segments {
- ...CustomerSegmentFragment
+ ...CustomerSegmentStorefrontFragment
}
status
store_credit {
@@ -3411,14 +3423,14 @@ Response
"customer": {
"addresses": [CustomerAddress],
"addressesV2": CustomerAddresses,
- "allow_remote_shopping_assistance": false,
+ "allow_remote_shopping_assistance": true,
"companies": UserCompaniesOutput,
"compare_list": CompareList,
"confirmation_status": "ACCOUNT_CONFIRMED",
"created_at": "abc123",
"custom_attributes": [AttributeValueInterface],
- "date_of_birth": "xyz789",
- "default_billing": "xyz789",
+ "date_of_birth": "abc123",
+ "default_billing": "abc123",
"default_shipping": "abc123",
"dob": "xyz789",
"email": "abc123",
@@ -3426,35 +3438,35 @@ Response
"gender": 123,
"gift_registries": [GiftRegistry],
"gift_registry": GiftRegistry,
- "group": CustomerGroup,
+ "group": CustomerGroupStorefront,
"group_id": 987,
- "id": 987,
- "is_subscribed": false,
+ "id": "4",
+ "is_subscribed": true,
"job_title": "xyz789",
- "lastname": "xyz789",
+ "lastname": "abc123",
"middlename": "abc123",
"orders": CustomerOrders,
- "prefix": "abc123",
+ "prefix": "xyz789",
"purchase_order": PurchaseOrder,
"purchase_order_approval_rule": PurchaseOrderApprovalRule,
"purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata,
"purchase_order_approval_rules": PurchaseOrderApprovalRules,
"purchase_orders": PurchaseOrders,
- "purchase_orders_enabled": true,
+ "purchase_orders_enabled": false,
"requisition_lists": RequisitionLists,
"return": Return,
"returns": Returns,
"reviews": ProductReviews,
"reward_points": RewardPoints,
"role": CompanyRole,
- "segments": [CustomerSegment],
+ "segments": [CustomerSegmentStorefront],
"status": "ACTIVE",
"store_credit": CustomerStoreCredit,
- "structure_id": "4",
+ "structure_id": 4,
"suffix": "abc123",
"taxvat": "abc123",
"team": CompanyTeam,
- "telephone": "abc123",
+ "telephone": "xyz789",
"wishlist": Wishlist,
"wishlist_v2": Wishlist,
"wishlists": [Wishlist]
@@ -3541,7 +3553,7 @@ Query
}
printed_card_included
rules {
- ...CartRuleFragment
+ ...CartRuleStorefrontFragment
}
selected_payment_method {
...SelectedPaymentMethodFragment
@@ -3574,12 +3586,12 @@ Response
"gift_receipt_included": true,
"gift_wrapping": GiftWrapping,
"id": "4",
- "is_virtual": false,
+ "is_virtual": true,
"items": [CartItemInterface],
"itemsV2": CartItems,
"prices": CartPrices,
- "printed_card_included": true,
- "rules": [CartRule],
+ "printed_card_included": false,
+ "rules": [CartRuleStorefront],
"selected_payment_method": SelectedPaymentMethod,
"shipping_addresses": [ShippingCartAddress],
"total_quantity": 123.45
@@ -3637,6 +3649,49 @@ Response
}
}
}
+
+
+
+ back to top
+
+
+
+
+ Queries
+
+
+ customerGroup
+
+
+
+
+ Description
+ Provides Customer Group assigned to the Customer or Guest.
+
+
+
+
+
+
+ Response
+ Returns a CustomerGroupStorefront!
+
+
+
+
+ Example
+
+ Query
+ query customerGroup {
+ customerGroup {
+ uid
+ }
+}
+
+
+
+ Response
+ {"data": {"customerGroup": {"uid": "4"}}}
@@ -3688,7 +3743,7 @@ Response
{
"data": {
"customerOrders": {
- "date_of_first_order": "abc123",
+ "date_of_first_order": "xyz789",
"items": [CustomerOrder],
"page_info": SearchResultPageInfo,
"total_count": 987
@@ -3744,6 +3799,77 @@ Response
"customerPaymentTokens": {"items": [PaymentToken]}
}
}
+
+
+
+ back to top
+
+
+
+
+ Queries
+
+
+ customerSegments
+
+
+
+
+ Description
+ Customer segments associated with the current customer or guest/visitor.
+
+
+
+
+
+
+ Response
+ Returns [CustomerSegmentStorefront]
+
+
+
+ Arguments
+
+
+
+ Name
+ Description
+
+
+
+
+
+ cartId - String!
+
+ The unique ID of the cart to query.
+
+
+
+
+
+
+ Example
+
+ Query
+ query customerSegments($cartId: String!) {
+ customerSegments(cartId: $cartId) {
+ uid
+ }
+}
+
+
+
+ Variables
+ {"cartId": "abc123"}
+
+
+
+ Response
+ {
+ "data": {
+ "customerSegments": [{"uid": "4"}]
+ }
+}
@@ -3995,9 +4121,9 @@ Response
"data": {
"getPayflowLinkToken": {
"mode": "TEST",
- "paypal_url": "xyz789",
- "secure_token": "abc123",
- "secure_token_id": "abc123"
+ "paypal_url": "abc123",
+ "secure_token": "xyz789",
+ "secure_token_id": "xyz789"
}
}
}
@@ -4058,6 +4184,9 @@ Query
apple_pay {
...ApplePayConfigFragment
}
+ fastlane {
+ ...FastlaneConfigFragment
+ }
google_pay {
...GooglePayConfigFragment
}
@@ -4082,6 +4211,7 @@ Response
"data": {
"getPaymentConfig": {
"apple_pay": ApplePayConfig,
+ "fastlane": FastlaneConfig,
"google_pay": GooglePayConfig,
"hosted_fields": HostedFieldsConfig,
"smart_buttons": SmartButtonsConfig
@@ -4167,7 +4297,7 @@ Query
Variables
{
- "cartId": "abc123",
+ "cartId": "xyz789",
"id": "abc123"
}
@@ -4469,7 +4599,7 @@ Query
Variables
- {"giftRegistryUid": "4"}
+ {"giftRegistryUid": 4}
@@ -4481,16 +4611,16 @@ Response
"dynamic_attributes": [
GiftRegistryDynamicAttribute
],
- "event_name": "xyz789",
+ "event_name": "abc123",
"items": [GiftRegistryItemInterface],
- "message": "abc123",
+ "message": "xyz789",
"owner_name": "abc123",
"privacy_settings": "PRIVATE",
"registrants": [GiftRegistryRegistrant],
"shipping_address": CustomerAddress,
"status": "ACTIVE",
"type": GiftRegistryType,
- "uid": 4
+ "uid": "4"
}
}
}
@@ -4560,7 +4690,7 @@ Query
Variables
- {"email": "abc123"}
+ {"email": "xyz789"}
@@ -4571,10 +4701,10 @@ Response
{
"event_date": "xyz789",
"event_title": "xyz789",
- "gift_registry_uid": "4",
- "location": "abc123",
- "name": "xyz789",
- "type": "xyz789"
+ "gift_registry_uid": 4,
+ "location": "xyz789",
+ "name": "abc123",
+ "type": "abc123"
}
]
}
@@ -4658,7 +4788,7 @@ Response
"event_title": "abc123",
"gift_registry_uid": 4,
"location": "abc123",
- "name": "xyz789",
+ "name": "abc123",
"type": "xyz789"
}
]
@@ -4752,8 +4882,8 @@ Query
Variables
{
"firstName": "abc123",
- "lastName": "xyz789",
- "giftRegistryTypeUid": "4"
+ "lastName": "abc123",
+ "giftRegistryTypeUid": 4
}
@@ -4763,11 +4893,11 @@ Response
"data": {
"giftRegistryTypeSearch": [
{
- "event_date": "abc123",
- "event_title": "xyz789",
- "gift_registry_uid": 4,
+ "event_date": "xyz789",
+ "event_title": "abc123",
+ "gift_registry_uid": "4",
"location": "abc123",
- "name": "abc123",
+ "name": "xyz789",
"type": "xyz789"
}
]
@@ -4872,7 +5002,7 @@ Arguments
- input - OrderInformationInput!
+ input - GuestOrderInformationInput!
@@ -4885,7 +5015,7 @@ Arguments
Example
Query
- query guestOrder($input: OrderInformationInput!) {
+ query guestOrder($input: GuestOrderInformationInput!) {
guestOrder(input: $input) {
applied_coupons {
...AppliedCouponFragment
@@ -4958,7 +5088,7 @@ Query
Variables
- {"input": OrderInformationInput}
+ {"input": GuestOrderInformationInput}
@@ -4983,7 +5113,7 @@ Response
"id": 4,
"increment_id": "xyz789",
"invoices": [Invoice],
- "is_virtual": false,
+ "is_virtual": true,
"items": [OrderItemInterface],
"items_eligible_for_return": [OrderItemInterface],
"number": "xyz789",
@@ -4991,11 +5121,11 @@ Response
"order_number": "abc123",
"order_status_change_date": "xyz789",
"payment_methods": [OrderPaymentMethod],
- "printed_card_included": true,
+ "printed_card_included": false,
"returns": Returns,
"shipments": [OrderShipment],
"shipping_address": OrderAddress,
- "shipping_method": "abc123",
+ "shipping_method": "xyz789",
"status": "xyz789",
"token": "abc123",
"total": OrderTotal
@@ -5140,32 +5270,32 @@ Response
"applied_gift_cards": [ApplyGiftCardToOrder],
"available_actions": ["REORDER"],
"billing_address": OrderAddress,
- "carrier": "abc123",
+ "carrier": "xyz789",
"comments": [SalesCommentItem],
- "created_at": "xyz789",
+ "created_at": "abc123",
"credit_memos": [CreditMemo],
"customer_info": OrderCustomerInfo,
- "email": "abc123",
+ "email": "xyz789",
"gift_message": GiftMessage,
"gift_receipt_included": true,
"gift_wrapping": GiftWrapping,
- "grand_total": 123.45,
- "id": "4",
- "increment_id": "xyz789",
+ "grand_total": 987.65,
+ "id": 4,
+ "increment_id": "abc123",
"invoices": [Invoice],
"is_virtual": false,
"items": [OrderItemInterface],
"items_eligible_for_return": [OrderItemInterface],
"number": "xyz789",
- "order_date": "xyz789",
+ "order_date": "abc123",
"order_number": "xyz789",
"order_status_change_date": "xyz789",
"payment_methods": [OrderPaymentMethod],
- "printed_card_included": false,
+ "printed_card_included": true,
"returns": Returns,
"shipments": [OrderShipment],
"shipping_address": OrderAddress,
- "shipping_method": "abc123",
+ "shipping_method": "xyz789",
"status": "abc123",
"token": "abc123",
"total": OrderTotal
@@ -5505,7 +5635,7 @@ Query
Variables
- {"email": "xyz789"}
+ {"email": "abc123"}
@@ -5624,7 +5754,7 @@ Response
"created_at": "abc123",
"email": "abc123",
"history": [NegotiableQuoteHistoryEntry],
- "is_virtual": false,
+ "is_virtual": true,
"items": [CartItemInterface],
"name": "xyz789",
"prices": CartPrices,
@@ -5743,13 +5873,13 @@ Response
"negotiableQuoteTemplate": {
"buyer": NegotiableQuoteUser,
"comments": [NegotiableQuoteComment],
- "expiration_date": "abc123",
+ "expiration_date": "xyz789",
"history": [NegotiableQuoteHistoryEntry],
"is_min_max_qty_used": false,
"is_virtual": false,
"items": [CartItemInterface],
- "max_order_commitment": 987,
- "min_order_commitment": 123,
+ "max_order_commitment": 123,
+ "min_order_commitment": 987,
"name": "xyz789",
"notifications": [QuoteTemplateNotificationMessage],
"prices": CartPrices,
@@ -5760,7 +5890,7 @@ Response
NegotiableQuoteShippingAddress
],
"status": "abc123",
- "template_id": 4,
+ "template_id": "4",
"total_quantity": 123.45
}
}
@@ -5997,7 +6127,7 @@ Response
"items": [NegotiableQuote],
"page_info": SearchResultPageInfo,
"sort_fields": SortFields,
- "total_count": 123
+ "total_count": 987
}
}
}
@@ -6129,7 +6259,7 @@ Response
"pickupLocations": {
"items": [PickupLocation],
"page_info": SearchResultPageInfo,
- "total_count": 987
+ "total_count": 123
}
}
}
@@ -6300,7 +6430,7 @@ Query
Variables
{
- "search": "abc123",
+ "search": "xyz789",
"filter": ProductAttributeFilterInput,
"pageSize": 20,
"currentPage": 1,
@@ -6319,7 +6449,7 @@ Response
"page_info": SearchResultPageInfo,
"sort_fields": SortFields,
"suggestions": [SearchSuggestion],
- "total_count": 123
+ "total_count": 987
}
}
}
@@ -6389,7 +6519,7 @@ Response
"data": {
"recaptchaFormConfig": {
"configurations": ReCaptchaConfiguration,
- "is_enabled": false
+ "is_enabled": true
}
}
}
@@ -6445,14 +6575,14 @@ Response
{
"data": {
"recaptchaV3Config": {
- "badge_position": "xyz789",
+ "badge_position": "abc123",
"failure_message": "xyz789",
"forms": ["PLACE_ORDER"],
- "is_enabled": true,
- "language_code": "abc123",
- "minimum_score": 123.45,
+ "is_enabled": false,
+ "language_code": "xyz789",
+ "minimum_score": 987.65,
"theme": "xyz789",
- "website_key": "xyz789"
+ "website_key": "abc123"
}
}
}
@@ -6519,7 +6649,7 @@ Query
Variables
- {"url": "abc123"}
+ {"url": "xyz789"}
@@ -6527,7 +6657,7 @@ Response
{
"data": {
"route": {
- "redirect_code": 987,
+ "redirect_code": 123,
"relative_url": "abc123",
"type": "CMS_PAGE"
}
@@ -6661,6 +6791,7 @@ Query
braintree_paypal_vault_active
cart_expires_in_days
cart_gift_wrapping
+ cart_merge_preference
cart_printed_card
cart_summary_display_quantity
catalog_default_sort_by
@@ -6705,7 +6836,6 @@ Query
fixed_product_taxes_enable
fixed_product_taxes_include_fpt_in_subtotal
front
- graphql_share_all_customer_groups
graphql_share_customer_group
grid_per_page
grid_per_page_values
@@ -6783,10 +6913,8 @@ Query
send_friend {
...SendFriendConfigurationFragment
}
- share_all_catalog_rules
- share_all_sales_rule
- share_applied_catalog_rules
- share_applied_sales_rule
+ share_active_segments
+ share_applied_cart_rule
shopping_cart_display_full_summary
shopping_cart_display_grand_total
shopping_cart_display_price
@@ -6829,246 +6957,244 @@ Response
"absolute_footer": "xyz789",
"allow_gift_receipt": "xyz789",
"allow_gift_wrapping_on_order": "xyz789",
- "allow_gift_wrapping_on_order_items": "xyz789",
- "allow_guests_to_write_product_reviews": "abc123",
- "allow_items": "abc123",
+ "allow_gift_wrapping_on_order_items": "abc123",
+ "allow_guests_to_write_product_reviews": "xyz789",
+ "allow_items": "xyz789",
"allow_order": "abc123",
"allow_printed_card": "xyz789",
"autocomplete_on_storefront": true,
"base_currency_code": "abc123",
- "base_link_url": "abc123",
- "base_media_url": "xyz789",
+ "base_link_url": "xyz789",
+ "base_media_url": "abc123",
"base_static_url": "abc123",
- "base_url": "abc123",
+ "base_url": "xyz789",
"braintree_3dsecure_allowspecific": true,
"braintree_3dsecure_always_request_3ds": false,
"braintree_3dsecure_specificcountry": "xyz789",
- "braintree_3dsecure_threshold_amount": "abc123",
+ "braintree_3dsecure_threshold_amount": "xyz789",
"braintree_3dsecure_verify_3dsecure": false,
"braintree_ach_direct_debit_vault_active": true,
"braintree_applepay_merchant_name": "xyz789",
- "braintree_applepay_vault_active": true,
- "braintree_cc_vault_active": "abc123",
+ "braintree_applepay_vault_active": false,
+ "braintree_cc_vault_active": "xyz789",
"braintree_cc_vault_cvv": false,
"braintree_environment": "abc123",
- "braintree_googlepay_btn_color": "abc123",
- "braintree_googlepay_cctypes": "xyz789",
+ "braintree_googlepay_btn_color": "xyz789",
+ "braintree_googlepay_cctypes": "abc123",
"braintree_googlepay_merchant_id": "abc123",
"braintree_googlepay_vault_active": true,
- "braintree_local_payment_allowed_methods": "abc123",
+ "braintree_local_payment_allowed_methods": "xyz789",
"braintree_local_payment_fallback_button_text": "abc123",
- "braintree_local_payment_redirect_on_fail": "xyz789",
- "braintree_merchant_account_id": "xyz789",
+ "braintree_local_payment_redirect_on_fail": "abc123",
+ "braintree_merchant_account_id": "abc123",
"braintree_paypal_button_location_cart_type_credit_color": "abc123",
"braintree_paypal_button_location_cart_type_credit_label": "abc123",
"braintree_paypal_button_location_cart_type_credit_shape": "xyz789",
"braintree_paypal_button_location_cart_type_credit_show": true,
- "braintree_paypal_button_location_cart_type_messaging_layout": "abc123",
- "braintree_paypal_button_location_cart_type_messaging_logo": "abc123",
+ "braintree_paypal_button_location_cart_type_messaging_layout": "xyz789",
+ "braintree_paypal_button_location_cart_type_messaging_logo": "xyz789",
"braintree_paypal_button_location_cart_type_messaging_logo_position": "abc123",
- "braintree_paypal_button_location_cart_type_messaging_show": true,
+ "braintree_paypal_button_location_cart_type_messaging_show": false,
"braintree_paypal_button_location_cart_type_messaging_text_color": "abc123",
- "braintree_paypal_button_location_cart_type_paylater_color": "abc123",
- "braintree_paypal_button_location_cart_type_paylater_label": "xyz789",
+ "braintree_paypal_button_location_cart_type_paylater_color": "xyz789",
+ "braintree_paypal_button_location_cart_type_paylater_label": "abc123",
"braintree_paypal_button_location_cart_type_paylater_shape": "abc123",
"braintree_paypal_button_location_cart_type_paylater_show": false,
"braintree_paypal_button_location_cart_type_paypal_color": "xyz789",
"braintree_paypal_button_location_cart_type_paypal_label": "abc123",
- "braintree_paypal_button_location_cart_type_paypal_shape": "abc123",
+ "braintree_paypal_button_location_cart_type_paypal_shape": "xyz789",
"braintree_paypal_button_location_cart_type_paypal_show": false,
- "braintree_paypal_button_location_checkout_type_credit_color": "xyz789",
+ "braintree_paypal_button_location_checkout_type_credit_color": "abc123",
"braintree_paypal_button_location_checkout_type_credit_label": "abc123",
- "braintree_paypal_button_location_checkout_type_credit_shape": "abc123",
+ "braintree_paypal_button_location_checkout_type_credit_shape": "xyz789",
"braintree_paypal_button_location_checkout_type_credit_show": true,
- "braintree_paypal_button_location_checkout_type_messaging_layout": "xyz789",
+ "braintree_paypal_button_location_checkout_type_messaging_layout": "abc123",
"braintree_paypal_button_location_checkout_type_messaging_logo": "abc123",
"braintree_paypal_button_location_checkout_type_messaging_logo_position": "abc123",
"braintree_paypal_button_location_checkout_type_messaging_show": true,
- "braintree_paypal_button_location_checkout_type_messaging_text_color": "abc123",
- "braintree_paypal_button_location_checkout_type_paylater_color": "xyz789",
+ "braintree_paypal_button_location_checkout_type_messaging_text_color": "xyz789",
+ "braintree_paypal_button_location_checkout_type_paylater_color": "abc123",
"braintree_paypal_button_location_checkout_type_paylater_label": "xyz789",
- "braintree_paypal_button_location_checkout_type_paylater_shape": "abc123",
- "braintree_paypal_button_location_checkout_type_paylater_show": false,
+ "braintree_paypal_button_location_checkout_type_paylater_shape": "xyz789",
+ "braintree_paypal_button_location_checkout_type_paylater_show": true,
"braintree_paypal_button_location_checkout_type_paypal_color": "xyz789",
- "braintree_paypal_button_location_checkout_type_paypal_label": "abc123",
+ "braintree_paypal_button_location_checkout_type_paypal_label": "xyz789",
"braintree_paypal_button_location_checkout_type_paypal_shape": "abc123",
- "braintree_paypal_button_location_checkout_type_paypal_show": false,
- "braintree_paypal_button_location_productpage_type_credit_color": "abc123",
- "braintree_paypal_button_location_productpage_type_credit_label": "abc123",
- "braintree_paypal_button_location_productpage_type_credit_shape": "xyz789",
+ "braintree_paypal_button_location_checkout_type_paypal_show": true,
+ "braintree_paypal_button_location_productpage_type_credit_color": "xyz789",
+ "braintree_paypal_button_location_productpage_type_credit_label": "xyz789",
+ "braintree_paypal_button_location_productpage_type_credit_shape": "abc123",
"braintree_paypal_button_location_productpage_type_credit_show": true,
- "braintree_paypal_button_location_productpage_type_messaging_layout": "xyz789",
- "braintree_paypal_button_location_productpage_type_messaging_logo": "xyz789",
- "braintree_paypal_button_location_productpage_type_messaging_logo_position": "abc123",
- "braintree_paypal_button_location_productpage_type_messaging_show": true,
+ "braintree_paypal_button_location_productpage_type_messaging_layout": "abc123",
+ "braintree_paypal_button_location_productpage_type_messaging_logo": "abc123",
+ "braintree_paypal_button_location_productpage_type_messaging_logo_position": "xyz789",
+ "braintree_paypal_button_location_productpage_type_messaging_show": false,
"braintree_paypal_button_location_productpage_type_messaging_text_color": "xyz789",
- "braintree_paypal_button_location_productpage_type_paylater_color": "abc123",
- "braintree_paypal_button_location_productpage_type_paylater_label": "xyz789",
+ "braintree_paypal_button_location_productpage_type_paylater_color": "xyz789",
+ "braintree_paypal_button_location_productpage_type_paylater_label": "abc123",
"braintree_paypal_button_location_productpage_type_paylater_shape": "xyz789",
- "braintree_paypal_button_location_productpage_type_paylater_show": false,
+ "braintree_paypal_button_location_productpage_type_paylater_show": true,
"braintree_paypal_button_location_productpage_type_paypal_color": "abc123",
- "braintree_paypal_button_location_productpage_type_paypal_label": "xyz789",
+ "braintree_paypal_button_location_productpage_type_paypal_label": "abc123",
"braintree_paypal_button_location_productpage_type_paypal_shape": "xyz789",
- "braintree_paypal_button_location_productpage_type_paypal_show": true,
- "braintree_paypal_credit_uk_merchant_name": "abc123",
- "braintree_paypal_display_on_shopping_cart": true,
+ "braintree_paypal_button_location_productpage_type_paypal_show": false,
+ "braintree_paypal_credit_uk_merchant_name": "xyz789",
+ "braintree_paypal_display_on_shopping_cart": false,
"braintree_paypal_merchant_country": "abc123",
"braintree_paypal_merchant_name_override": "xyz789",
"braintree_paypal_require_billing_address": false,
- "braintree_paypal_send_cart_line_items": false,
+ "braintree_paypal_send_cart_line_items": true,
"braintree_paypal_vault_active": true,
- "cart_expires_in_days": 987,
+ "cart_expires_in_days": 123,
"cart_gift_wrapping": "abc123",
+ "cart_merge_preference": "abc123",
"cart_printed_card": "xyz789",
- "cart_summary_display_quantity": 123,
- "catalog_default_sort_by": "xyz789",
+ "cart_summary_display_quantity": 987,
+ "catalog_default_sort_by": "abc123",
"category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
- "category_url_suffix": "xyz789",
- "check_money_order_enable_for_specific_countries": false,
- "check_money_order_enabled": true,
- "check_money_order_make_check_payable_to": "xyz789",
- "check_money_order_max_order_total": "abc123",
+ "category_url_suffix": "abc123",
+ "check_money_order_enable_for_specific_countries": true,
+ "check_money_order_enabled": false,
+ "check_money_order_make_check_payable_to": "abc123",
+ "check_money_order_max_order_total": "xyz789",
"check_money_order_min_order_total": "xyz789",
"check_money_order_new_order_status": "abc123",
- "check_money_order_payment_from_specific_countries": "xyz789",
+ "check_money_order_payment_from_specific_countries": "abc123",
"check_money_order_send_check_to": "abc123",
- "check_money_order_sort_order": 987,
+ "check_money_order_sort_order": 123,
"check_money_order_title": "xyz789",
- "cms_home_page": "abc123",
+ "cms_home_page": "xyz789",
"cms_no_cookies": "abc123",
- "cms_no_route": "xyz789",
+ "cms_no_route": "abc123",
"code": "xyz789",
"configurable_product_image": "ITSELF",
- "configurable_thumbnail_source": "abc123",
- "contact_enabled": true,
- "copyright": "abc123",
+ "configurable_thumbnail_source": "xyz789",
+ "contact_enabled": false,
+ "copyright": "xyz789",
"countries_with_required_region": "xyz789",
"create_account_confirmation": false,
"customer_access_token_lifetime": 123.45,
"default_country": "abc123",
- "default_description": "abc123",
- "default_display_currency_code": "xyz789",
- "default_keywords": "abc123",
- "default_title": "abc123",
- "demonotice": 123,
+ "default_description": "xyz789",
+ "default_display_currency_code": "abc123",
+ "default_keywords": "xyz789",
+ "default_title": "xyz789",
+ "demonotice": 987,
"display_product_prices_in_catalog": 123,
"display_shipping_prices": 123,
"display_state_if_optional": false,
- "enable_multiple_wishlists": "xyz789",
+ "enable_multiple_wishlists": "abc123",
"fixed_product_taxes_apply_tax_to_fpt": true,
"fixed_product_taxes_display_prices_in_emails": 987,
- "fixed_product_taxes_display_prices_in_product_lists": 123,
+ "fixed_product_taxes_display_prices_in_product_lists": 987,
"fixed_product_taxes_display_prices_in_sales_modules": 123,
- "fixed_product_taxes_display_prices_on_product_view_page": 987,
- "fixed_product_taxes_enable": true,
+ "fixed_product_taxes_display_prices_on_product_view_page": 123,
+ "fixed_product_taxes_enable": false,
"fixed_product_taxes_include_fpt_in_subtotal": false,
"front": "xyz789",
- "graphql_share_all_customer_groups": true,
"graphql_share_customer_group": false,
"grid_per_page": 987,
- "grid_per_page_values": "abc123",
+ "grid_per_page_values": "xyz789",
"grouped_product_image": "ITSELF",
"head_includes": "xyz789",
"head_shortcut_icon": "abc123",
- "header_logo_src": "abc123",
- "id": 123,
- "is_checkout_agreements_enabled": true,
+ "header_logo_src": "xyz789",
+ "id": 987,
+ "is_checkout_agreements_enabled": false,
"is_default_store": true,
"is_default_store_group": true,
"is_guest_checkout_enabled": true,
"is_negotiable_quote_active": true,
- "is_one_page_checkout_enabled": true,
- "is_requisition_list_active": "xyz789",
+ "is_one_page_checkout_enabled": false,
+ "is_requisition_list_active": "abc123",
"list_mode": "xyz789",
"list_per_page": 987,
"list_per_page_values": "xyz789",
"locale": "xyz789",
- "logo_alt": "abc123",
+ "logo_alt": "xyz789",
"logo_height": 987,
- "logo_width": 987,
+ "logo_width": 123,
"magento_reward_general_is_enabled": "xyz789",
- "magento_reward_general_is_enabled_on_front": "abc123",
- "magento_reward_general_min_points_balance": "xyz789",
+ "magento_reward_general_is_enabled_on_front": "xyz789",
+ "magento_reward_general_min_points_balance": "abc123",
"magento_reward_general_publish_history": "abc123",
- "magento_reward_points_invitation_customer": "abc123",
- "magento_reward_points_invitation_customer_limit": "abc123",
- "magento_reward_points_invitation_order": "xyz789",
- "magento_reward_points_invitation_order_limit": "abc123",
+ "magento_reward_points_invitation_customer": "xyz789",
+ "magento_reward_points_invitation_customer_limit": "xyz789",
+ "magento_reward_points_invitation_order": "abc123",
+ "magento_reward_points_invitation_order_limit": "xyz789",
"magento_reward_points_newsletter": "abc123",
"magento_reward_points_order": "xyz789",
- "magento_reward_points_register": "abc123",
- "magento_reward_points_review": "xyz789",
- "magento_reward_points_review_limit": "abc123",
+ "magento_reward_points_register": "xyz789",
+ "magento_reward_points_review": "abc123",
+ "magento_reward_points_review_limit": "xyz789",
"magento_wishlist_general_is_enabled": "abc123",
- "max_items_in_order_summary": 123,
- "maximum_number_of_wishlists": "abc123",
+ "max_items_in_order_summary": 987,
+ "maximum_number_of_wishlists": "xyz789",
"minicart_display": true,
"minicart_max_items": 987,
- "minimum_password_length": "xyz789",
- "newsletter_enabled": false,
+ "minimum_password_length": "abc123",
+ "newsletter_enabled": true,
"no_route": "abc123",
- "optional_zip_countries": "xyz789",
- "order_cancellation_enabled": true,
+ "optional_zip_countries": "abc123",
+ "order_cancellation_enabled": false,
"order_cancellation_reasons": [CancellationReason],
- "orders_invoices_credit_memos_display_full_summary": false,
- "orders_invoices_credit_memos_display_grandtotal": false,
+ "orders_invoices_credit_memos_display_full_summary": true,
+ "orders_invoices_credit_memos_display_grandtotal": true,
"orders_invoices_credit_memos_display_price": 987,
"orders_invoices_credit_memos_display_shipping_amount": 123,
"orders_invoices_credit_memos_display_subtotal": 123,
- "orders_invoices_credit_memos_display_zero_tax": false,
- "payment_payflowpro_cc_vault_active": "abc123",
- "printed_card_price": "xyz789",
+ "orders_invoices_credit_memos_display_zero_tax": true,
+ "payment_payflowpro_cc_vault_active": "xyz789",
+ "printed_card_price": "abc123",
"printed_card_priceV2": Money,
"product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
"product_reviews_enabled": "abc123",
- "product_url_suffix": "abc123",
+ "product_url_suffix": "xyz789",
"quickorder_active": true,
"required_character_classes_number": "abc123",
- "returns_enabled": "abc123",
+ "returns_enabled": "xyz789",
"root_category_id": 987,
- "root_category_uid": 4,
+ "root_category_uid": "4",
"sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
- "sales_gift_wrapping": "xyz789",
- "sales_printed_card": "xyz789",
+ "sales_gift_wrapping": "abc123",
+ "sales_printed_card": "abc123",
"secure_base_link_url": "abc123",
- "secure_base_media_url": "abc123",
+ "secure_base_media_url": "xyz789",
"secure_base_static_url": "abc123",
"secure_base_url": "abc123",
"send_friend": SendFriendConfiguration,
- "share_all_catalog_rules": false,
- "share_all_sales_rule": false,
- "share_applied_catalog_rules": true,
- "share_applied_sales_rule": false,
- "shopping_cart_display_full_summary": true,
+ "share_active_segments": true,
+ "share_applied_cart_rule": false,
+ "shopping_cart_display_full_summary": false,
"shopping_cart_display_grand_total": true,
"shopping_cart_display_price": 987,
- "shopping_cart_display_shipping": 123,
+ "shopping_cart_display_shipping": 987,
"shopping_cart_display_subtotal": 987,
"shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX",
"shopping_cart_display_zero_tax": true,
"show_cms_breadcrumbs": 987,
- "store_code": "4",
- "store_group_code": 4,
+ "store_code": 4,
+ "store_group_code": "4",
"store_group_name": "abc123",
"store_name": "xyz789",
- "store_sort_order": 987,
- "timezone": "xyz789",
+ "store_sort_order": 123,
+ "timezone": "abc123",
"title_prefix": "abc123",
- "title_separator": "abc123",
+ "title_separator": "xyz789",
"title_suffix": "abc123",
- "use_store_in_url": true,
+ "use_store_in_url": false,
"website_code": "4",
"website_id": 987,
- "website_name": "xyz789",
+ "website_name": "abc123",
"weight_unit": "abc123",
- "welcome": "abc123",
+ "welcome": "xyz789",
"zero_subtotal_enable_for_specific_countries": false,
- "zero_subtotal_enabled": true,
+ "zero_subtotal_enabled": false,
"zero_subtotal_new_order_status": "xyz789",
- "zero_subtotal_payment_action": "abc123",
- "zero_subtotal_payment_from_specific_countries": "abc123",
- "zero_subtotal_sort_order": 123,
- "zero_subtotal_title": "abc123"
+ "zero_subtotal_payment_action": "xyz789",
+ "zero_subtotal_payment_from_specific_countries": "xyz789",
+ "zero_subtotal_sort_order": 987,
+ "zero_subtotal_title": "xyz789"
}
}
}
@@ -7153,10 +7279,10 @@ Response
{
"data": {
"urlResolver": {
- "canonical_url": "xyz789",
- "entity_uid": "4",
+ "canonical_url": "abc123",
+ "entity_uid": 4,
"id": 123,
- "redirectCode": 987,
+ "redirectCode": 123,
"relative_url": "xyz789",
"type": "CMS_PAGE"
}
@@ -7221,8 +7347,8 @@ Response
"data": {
"wishlist": {
"items": [WishlistItem],
- "items_count": 987,
- "name": "abc123",
+ "items_count": 123,
+ "name": "xyz789",
"sharing_code": "xyz789",
"updated_at": "abc123"
}
@@ -7293,7 +7419,7 @@ Variables
Response
- {"data": {"acceptCompanyInvitation": {"success": false}}}
+ {"data": {"acceptCompanyInvitation": {"success": true}}}
@@ -7399,11 +7525,11 @@ Response
"comments": [NegotiableQuoteComment],
"expiration_date": "abc123",
"history": [NegotiableQuoteHistoryEntry],
- "is_min_max_qty_used": true,
+ "is_min_max_qty_used": false,
"is_virtual": true,
"items": [CartItemInterface],
"max_order_commitment": 123,
- "min_order_commitment": 987,
+ "min_order_commitment": 123,
"name": "abc123",
"notifications": [QuoteTemplateNotificationMessage],
"prices": CartPrices,
@@ -7414,7 +7540,7 @@ Response
NegotiableQuoteShippingAddress
],
"status": "abc123",
- "template_id": 4,
+ "template_id": "4",
"total_quantity": 123.45
}
}
@@ -7897,7 +8023,86 @@ Response
"attributes": [ComparableAttribute],
"item_count": 987,
"items": [ComparableItem],
- "uid": 4
+ "uid": "4"
+ }
+ }
+}
+
+
+
+ back to top
+
+
+
+
+ Mutations
+
+
+ addProductsToNewCart
+
+
+
+
+ Description
+ Creates a new cart and add any type of product to it
+
+
+
+
+
+
+ Response
+ Returns an AddProductsToNewCartOutput
+
+
+
+ Arguments
+
+
+
+ Name
+ Description
+
+
+
+
+
+ cartItems - [CartItemInput!]!
+
+ An array that defines the products to add to the new cart
+
+
+
+
+
+
+ Example
+
+ Query
+ mutation addProductsToNewCart($cartItems: [CartItemInput!]!) {
+ addProductsToNewCart(cartItems: $cartItems) {
+ cart {
+ ...CartFragment
+ }
+ user_errors {
+ ...CartUserInputErrorFragment
+ }
+ }
+}
+
+
+
+ Variables
+ {"cartItems": [CartItemInput]}
+
+
+
+ Response
+ {
+ "data": {
+ "addProductsToNewCart": {
+ "cart": Cart,
+ "user_errors": [CartUserInputError]
}
}
}
@@ -7977,7 +8182,7 @@ Query
Variables
{
- "requisitionListUid": 4,
+ "requisitionListUid": "4",
"requisitionListItems": [RequisitionListItemsInput]
}
@@ -8698,7 +8903,10 @@ Query
Variables
- {"wishlistId": "4", "wishlistItemIds": [4]}
+ {
+ "wishlistId": "4",
+ "wishlistItemIds": ["4"]
+}
@@ -9213,7 +9421,7 @@ Response
"data": {
"assignCompareListToCustomer": {
"compare_list": CompareList,
- "result": true
+ "result": false
}
}
}
@@ -9317,7 +9525,7 @@ Query
}
printed_card_included
rules {
- ...CartRuleFragment
+ ...CartRuleStorefrontFragment
}
selected_payment_method {
...SelectedPaymentMethodFragment
@@ -9350,20 +9558,20 @@ Response
AvailablePaymentMethod
],
"billing_address": BillingCartAddress,
- "email": "abc123",
+ "email": "xyz789",
"gift_message": GiftMessage,
- "gift_receipt_included": false,
+ "gift_receipt_included": true,
"gift_wrapping": GiftWrapping,
"id": "4",
- "is_virtual": false,
+ "is_virtual": true,
"items": [CartItemInterface],
"itemsV2": CartItems,
"prices": CartPrices,
"printed_card_included": false,
- "rules": [CartRule],
+ "rules": [CartRuleStorefront],
"selected_payment_method": SelectedPaymentMethod,
"shipping_addresses": [ShippingCartAddress],
- "total_quantity": 987.65
+ "total_quantity": 123.45
}
}
}
@@ -9472,12 +9680,12 @@ Response
"comments": [NegotiableQuoteComment],
"expiration_date": "xyz789",
"history": [NegotiableQuoteHistoryEntry],
- "is_min_max_qty_used": false,
+ "is_min_max_qty_used": true,
"is_virtual": true,
"items": [CartItemInterface],
- "max_order_commitment": 123,
+ "max_order_commitment": 987,
"min_order_commitment": 123,
- "name": "abc123",
+ "name": "xyz789",
"notifications": [QuoteTemplateNotificationMessage],
"prices": CartPrices,
"reference_document_links": [
@@ -9488,7 +9696,7 @@ Response
],
"status": "xyz789",
"template_id": 4,
- "total_quantity": 987.65
+ "total_quantity": 123.45
}
}
}
@@ -9568,7 +9776,7 @@ Response
{
"data": {
"cancelOrder": {
- "error": "xyz789",
+ "error": "abc123",
"errorV2": CancelOrderError,
"order": CustomerOrder
}
@@ -9752,7 +9960,7 @@ Query
...GiftRegistryFragment
}
group {
- ...CustomerGroupFragment
+ ...CustomerGroupStorefrontFragment
}
group_id
id
@@ -9799,7 +10007,7 @@ Query
...CompanyRoleFragment
}
segments {
- ...CustomerSegmentFragment
+ ...CustomerSegmentStorefrontFragment
}
status
store_credit {
@@ -9828,7 +10036,7 @@ Query
Variables
{
- "currentPassword": "abc123",
+ "currentPassword": "xyz789",
"newPassword": "xyz789"
}
@@ -9840,50 +10048,50 @@ Response
"changeCustomerPassword": {
"addresses": [CustomerAddress],
"addressesV2": CustomerAddresses,
- "allow_remote_shopping_assistance": false,
+ "allow_remote_shopping_assistance": true,
"companies": UserCompaniesOutput,
"compare_list": CompareList,
"confirmation_status": "ACCOUNT_CONFIRMED",
"created_at": "xyz789",
"custom_attributes": [AttributeValueInterface],
- "date_of_birth": "abc123",
+ "date_of_birth": "xyz789",
"default_billing": "abc123",
"default_shipping": "abc123",
- "dob": "xyz789",
+ "dob": "abc123",
"email": "abc123",
"firstname": "abc123",
- "gender": 123,
+ "gender": 987,
"gift_registries": [GiftRegistry],
"gift_registry": GiftRegistry,
- "group": CustomerGroup,
+ "group": CustomerGroupStorefront,
"group_id": 123,
- "id": 987,
- "is_subscribed": true,
+ "id": "4",
+ "is_subscribed": false,
"job_title": "xyz789",
- "lastname": "xyz789",
+ "lastname": "abc123",
"middlename": "abc123",
"orders": CustomerOrders,
- "prefix": "abc123",
+ "prefix": "xyz789",
"purchase_order": PurchaseOrder,
"purchase_order_approval_rule": PurchaseOrderApprovalRule,
"purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata,
"purchase_order_approval_rules": PurchaseOrderApprovalRules,
"purchase_orders": PurchaseOrders,
- "purchase_orders_enabled": true,
+ "purchase_orders_enabled": false,
"requisition_lists": RequisitionLists,
"return": Return,
"returns": Returns,
"reviews": ProductReviews,
"reward_points": RewardPoints,
"role": CompanyRole,
- "segments": [CustomerSegment],
+ "segments": [CustomerSegmentStorefront],
"status": "ACTIVE",
"store_credit": CustomerStoreCredit,
- "structure_id": "4",
+ "structure_id": 4,
"suffix": "xyz789",
"taxvat": "abc123",
"team": CompanyTeam,
- "telephone": "xyz789",
+ "telephone": "abc123",
"wishlist": Wishlist,
"wishlist_v2": Wishlist,
"wishlists": [Wishlist]
@@ -10043,6 +10251,85 @@ Response
"clearCustomerCart": {"cart": Cart, "status": false}
}
}
+
+
+
+ back to top
+
+
+
+
+ Mutations
+
+
+ clearWishlist
+
+
+
+
+ Description
+ Remove all the products from the specified wish list.
+
+
+
+
+
+
+ Response
+ Returns a RemoveProductsFromWishlistOutput
+
+
+
+ Arguments
+
+
+
+ Name
+ Description
+
+
+
+
+
+ wishlistId - ID!
+
+ The ID of a wish list.
+
+
+
+
+
+
+ Example
+
+ Query
+ mutation clearWishlist($wishlistId: ID!) {
+ clearWishlist(wishlistId: $wishlistId) {
+ user_errors {
+ ...WishListUserInputErrorFragment
+ }
+ wishlist {
+ ...WishlistFragment
+ }
+ }
+}
+
+
+
+ Variables
+ {"wishlistId": "4"}
+
+
+
+ Response
+ {
+ "data": {
+ "clearWishlist": {
+ "user_errors": [WishListUserInputError],
+ "wishlist": Wishlist
+ }
+ }
+}
@@ -10135,6 +10422,89 @@ Response
}
}
}
+
+
+
+ back to top
+
+
+
+
+ Mutations
+
+
+ completeOrder
+
+
+
+
+ Description
+ Synchronizes order details and place the order
+
+
+
+
+
+
+ Response
+ Returns a PlaceOrderOutput
+
+
+
+ Arguments
+
+
+
+ Name
+ Description
+
+
+
+
+
+ input - CompleteOrderInput
+
+ Describes the variables needed to complete or place the order
+
+
+
+
+
+
+ Example
+
+ Query
+ mutation completeOrder($input: CompleteOrderInput) {
+ completeOrder(input: $input) {
+ errors {
+ ...PlaceOrderErrorFragment
+ }
+ order {
+ ...OrderFragment
+ }
+ orderV2 {
+ ...CustomerOrderFragment
+ }
+ }
+}
+
+
+
+ Variables
+ {"input": CompleteOrderInput}
+
+
+
+ Response
+ {
+ "data": {
+ "completeOrder": {
+ "errors": [PlaceOrderError],
+ "order": Order,
+ "orderV2": CustomerOrder
+ }
+ }
+}
@@ -10211,7 +10581,7 @@ Response
{
"data": {
"confirmCancelOrder": {
- "error": "xyz789",
+ "error": "abc123",
"errorV2": CancelOrderError,
"order": CustomerOrder
}
@@ -10518,7 +10888,7 @@ Query
Variables
{
"sourceRequisitionListUid": 4,
- "destinationRequisitionListUid": "4",
+ "destinationRequisitionListUid": 4,
"requisitionListItem": CopyItemsBetweenRequisitionListsInput
}
@@ -10622,8 +10992,8 @@ Query
Variables
{
- "sourceWishlistUid": 4,
- "destinationWishlistUid": "4",
+ "sourceWishlistUid": "4",
+ "destinationWishlistUid": 4,
"wishlistItems": [WishlistItemCopyInput]
}
@@ -10726,7 +11096,7 @@ Query
Response
{
"data": {
- "createBraintreePayPalClientToken": "abc123"
+ "createBraintreePayPalClientToken": "xyz789"
}
}
@@ -11157,9 +11527,9 @@ Response
"data": {
"createCompareList": {
"attributes": [ComparableAttribute],
- "item_count": 987,
+ "item_count": 123,
"items": [ComparableItem],
- "uid": 4
+ "uid": "4"
}
}
}
@@ -11316,6 +11686,7 @@ Query
street
suffix
telephone
+ uid
vat_id
}
}
@@ -11332,28 +11703,29 @@ Response
"data": {
"createCustomerAddress": {
"city": "xyz789",
- "company": "abc123",
+ "company": "xyz789",
"country_code": "AF",
- "country_id": "abc123",
+ "country_id": "xyz789",
"custom_attributes": [CustomerAddressAttribute],
"custom_attributesV2": [AttributeValueInterface],
"customer_id": 987,
- "default_billing": false,
+ "default_billing": true,
"default_shipping": false,
"extension_attributes": [CustomerAddressAttribute],
- "fax": "xyz789",
+ "fax": "abc123",
"firstname": "xyz789",
- "id": 123,
- "lastname": "xyz789",
- "middlename": "xyz789",
+ "id": 987,
+ "lastname": "abc123",
+ "middlename": "abc123",
"postcode": "abc123",
- "prefix": "abc123",
+ "prefix": "xyz789",
"region": CustomerAddressRegion,
- "region_id": 123,
+ "region_id": 987,
"street": ["xyz789"],
- "suffix": "xyz789",
- "telephone": "abc123",
- "vat_id": "xyz789"
+ "suffix": "abc123",
+ "telephone": "xyz789",
+ "uid": "4",
+ "vat_id": "abc123"
}
}
}
@@ -11497,7 +11869,7 @@ Variables
Response
- {"data": {"createEmptyCart": "xyz789"}}
+ {"data": {"createEmptyCart": "abc123"}}
@@ -11714,11 +12086,11 @@ Response
{
"data": {
"createPayflowProToken": {
- "response_message": "xyz789",
- "result": 987,
- "result_code": 123,
- "secure_token": "xyz789",
- "secure_token_id": "abc123"
+ "response_message": "abc123",
+ "result": 123,
+ "result_code": 987,
+ "secure_token": "abc123",
+ "secure_token_id": "xyz789"
}
}
}
@@ -11795,9 +12167,9 @@ Response
{
"data": {
"createPaymentOrder": {
- "amount": 987.65,
+ "amount": 123.45,
"currency_code": "xyz789",
- "id": "abc123",
+ "id": "xyz789",
"mp_order_id": "abc123",
"status": "xyz789"
}
@@ -12041,13 +12413,13 @@ Response
"applies_to_roles": [CompanyRole],
"approver_roles": [CompanyRole],
"condition": PurchaseOrderApprovalRuleConditionInterface,
- "created_at": "xyz789",
+ "created_at": "abc123",
"created_by": "xyz789",
"description": "xyz789",
- "name": "xyz789",
+ "name": "abc123",
"status": "ENABLED",
"uid": "4",
- "updated_at": "xyz789"
+ "updated_at": "abc123"
}
}
}
@@ -12273,7 +12645,7 @@ Response
{
"data": {
"createVaultCardSetupToken": {
- "setup_token": "abc123"
+ "setup_token": "xyz789"
}
}
}
@@ -12413,7 +12785,7 @@ Variables
Response
- {"data": {"deleteCompanyRole": {"success": true}}}
+ {"data": {"deleteCompanyRole": {"success": false}}}
@@ -12481,7 +12853,7 @@ Variables
Response
- {"data": {"deleteCompanyTeam": {"success": true}}}
+ {"data": {"deleteCompanyTeam": {"success": false}}}
@@ -12556,7 +12928,7 @@ Variables
Response
- {"data": {"deleteCompanyUser": {"success": false}}}
+ {"data": {"deleteCompanyUser": {"success": true}}}
@@ -12624,7 +12996,7 @@ Variables
Response
- {"data": {"deleteCompanyUserV2": {"success": true}}}
+ {"data": {"deleteCompanyUserV2": {"success": false}}}
@@ -12691,7 +13063,7 @@ Variables
Response
- {"data": {"deleteCompareList": {"result": false}}}
+ {"data": {"deleteCompareList": {"result": true}}}
@@ -12743,9 +13115,16 @@ Response
-
+
deleteCustomerAddress
+
+
+
+ Use deleteCustomerAddressV2 instead.
+
+
+
@@ -12792,12 +13171,77 @@ Query
Variables
- {"id": 123}
+ {"id": 987}
+
+
+
+ Response
+ {"data": {"deleteCustomerAddress": true}}
+
+
+
+ back to top
+
+
+
+
+ Mutations
+
+
+ deleteCustomerAddressV2
+
+
+
+
+ Description
+ Delete the billing or shipping address of a customer.
+
+
+
+
+
+
+ Response
+ Returns a Boolean
+
+
+
+ Arguments
+
+
+
+ Name
+ Description
+
+
+
+
+
+ uid - ID!
+
+ The unique ID of the customer address to be deleted.
+
+
+
+
+
+
+ Example
+
+ Query
+ mutation deleteCustomerAddressV2($uid: ID!) {
+ deleteCustomerAddressV2(uid: $uid)
+}
+
+
+
+ Variables
+ {"uid": 4}
Response
- {"data": {"deleteCustomerAddress": false}}
+ {"data": {"deleteCustomerAddressV2": true}}
@@ -12862,7 +13306,7 @@ Variables
Response
- {"data": {"deleteNegotiableQuoteTemplate": true}}
+ {"data": {"deleteNegotiableQuoteTemplate": false}}
@@ -13015,7 +13459,7 @@ Query
Variables
- {"public_hash": "abc123"}
+ {"public_hash": "xyz789"}
@@ -13177,7 +13621,7 @@ Response
"data": {
"deleteRequisitionList": {
"requisition_lists": RequisitionLists,
- "status": true
+ "status": false
}
}
}
@@ -13256,10 +13700,7 @@ Query
Variables
- {
- "requisitionListUid": 4,
- "requisitionListItemUids": ["4"]
-}
+ {"requisitionListUid": 4, "requisitionListItemUids": [4]}
@@ -13335,7 +13776,7 @@ Query
Variables
- {"wishlistId": 4}
+ {"wishlistId": "4"}
@@ -13509,13 +13950,13 @@ Response
"estimateShippingMethods": [
{
"amount": Money,
- "available": false,
+ "available": true,
"base_amount": Money,
"carrier_code": "xyz789",
- "carrier_title": "abc123",
- "error_message": "xyz789",
- "method_code": "abc123",
- "method_title": "xyz789",
+ "carrier_title": "xyz789",
+ "error_message": "abc123",
+ "method_code": "xyz789",
+ "method_title": "abc123",
"price_excl_tax": Money,
"price_incl_tax": Money
}
@@ -13591,6 +14032,83 @@ Variables
Response
{"data": {"estimateTotals": {"cart": Cart}}}
+
+
+
+ back to top
+
+
+
+
+ Mutations
+
+
+ exchangeExternalCustomerToken
+
+
+
+
+ Description
+ Generate a token for specified customer.
+
+
+
+
+
+
+ Response
+ Returns an ExchangeExternalCustomerTokenOutput
+
+
+
+ Arguments
+
+
+
+ Name
+ Description
+
+
+
+
+
+ input - ExchangeExternalCustomerTokenInput
+
+ Contains details about external customer.
+
+
+
+
+
+
+ Example
+
+ Query
+ mutation exchangeExternalCustomerToken($input: ExchangeExternalCustomerTokenInput) {
+ exchangeExternalCustomerToken(input: $input) {
+ customer {
+ ...CustomerFragment
+ }
+ token
+ }
+}
+
+
+
+ Variables
+ {"input": ExchangeExternalCustomerTokenInput}
+
+
+
+ Response
+ {
+ "data": {
+ "exchangeExternalCustomerToken": {
+ "customer": Customer,
+ "token": "abc123"
+ }
+ }
+}
@@ -13666,7 +14184,7 @@ Query
Variables
{
"email": "xyz789",
- "password": "abc123"
+ "password": "xyz789"
}
@@ -13675,7 +14193,7 @@ Response
{
"data": {
"generateCustomerToken": {
- "token": "abc123"
+ "token": "xyz789"
}
}
}
@@ -13748,7 +14266,7 @@ Response
{
"data": {
"generateCustomerTokenAsAdmin": {
- "customer_token": "xyz789"
+ "customer_token": "abc123"
}
}
}
@@ -13818,7 +14336,13 @@ Variables
Response
- {"data": {"generateNegotiableQuoteFromTemplate": {"negotiable_quote_uid": 4}}}
+ {
+ "data": {
+ "generateNegotiableQuoteFromTemplate": {
+ "negotiable_quote_uid": "4"
+ }
+ }
+}
@@ -13999,7 +14523,7 @@ Query
}
printed_card_included
rules {
- ...CartRuleFragment
+ ...CartRuleStorefrontFragment
}
selected_payment_method {
...SelectedPaymentMethodFragment
@@ -14039,13 +14563,13 @@ Response
"gift_message": GiftMessage,
"gift_receipt_included": false,
"gift_wrapping": GiftWrapping,
- "id": "4",
+ "id": 4,
"is_virtual": false,
"items": [CartItemInterface],
"itemsV2": CartItems,
"prices": CartPrices,
- "printed_card_included": false,
- "rules": [CartRule],
+ "printed_card_included": true,
+ "rules": [CartRuleStorefront],
"selected_payment_method": SelectedPaymentMethod,
"shipping_addresses": [ShippingCartAddress],
"total_quantity": 123.45
@@ -14131,7 +14655,7 @@ Query
Variables
- {"cartUid": "4", "giftRegistryUid": 4}
+ {"cartUid": 4, "giftRegistryUid": "4"}
@@ -14140,7 +14664,7 @@ Response
"data": {
"moveCartItemsToGiftRegistry": {
"gift_registry": GiftRegistry,
- "status": true,
+ "status": false,
"user_errors": [GiftRegistryItemsUserError]
}
}
@@ -14233,7 +14757,7 @@ Query
Variables
{
"sourceRequisitionListUid": 4,
- "destinationRequisitionListUid": "4",
+ "destinationRequisitionListUid": 4,
"requisitionListItem": MoveItemsBetweenRequisitionListsInput
}
@@ -14413,7 +14937,7 @@ Query
Variables
{
- "sourceWishlistUid": 4,
+ "sourceWishlistUid": "4",
"destinationWishlistUid": "4",
"wishlistItems": [WishlistItemMoveInput]
}
@@ -14535,12 +15059,12 @@ Response
"comments": [NegotiableQuoteComment],
"expiration_date": "abc123",
"history": [NegotiableQuoteHistoryEntry],
- "is_min_max_qty_used": true,
- "is_virtual": true,
+ "is_min_max_qty_used": false,
+ "is_virtual": false,
"items": [CartItemInterface],
"max_order_commitment": 123,
"min_order_commitment": 987,
- "name": "xyz789",
+ "name": "abc123",
"notifications": [QuoteTemplateNotificationMessage],
"prices": CartPrices,
"reference_document_links": [
@@ -14549,9 +15073,9 @@ Response
"shipping_addresses": [
NegotiableQuoteShippingAddress
],
- "status": "xyz789",
- "template_id": 4,
- "total_quantity": 123.45
+ "status": "abc123",
+ "template_id": "4",
+ "total_quantity": 987.65
}
}
}
@@ -14931,7 +15455,7 @@ Response
"data": {
"redeemGiftCardBalanceAsStoreCredit": {
"balance": Money,
- "code": "xyz789",
+ "code": "abc123",
"expiration_date": "abc123"
}
}
@@ -15289,7 +15813,7 @@ Variables
Response
- {"data": {"removeGiftRegistry": {"success": true}}}
+ {"data": {"removeGiftRegistry": {"success": false}}}
@@ -15452,7 +15976,10 @@ Query
Variables
- {"giftRegistryUid": 4, "registrantsUid": [4]}
+ {
+ "giftRegistryUid": "4",
+ "registrantsUid": ["4"]
+}
@@ -15711,14 +16238,14 @@ Response
"removeNegotiableQuoteTemplateItems": {
"buyer": NegotiableQuoteUser,
"comments": [NegotiableQuoteComment],
- "expiration_date": "abc123",
+ "expiration_date": "xyz789",
"history": [NegotiableQuoteHistoryEntry],
"is_min_max_qty_used": false,
- "is_virtual": true,
+ "is_virtual": false,
"items": [CartItemInterface],
- "max_order_commitment": 987,
+ "max_order_commitment": 123,
"min_order_commitment": 987,
- "name": "abc123",
+ "name": "xyz789",
"notifications": [QuoteTemplateNotificationMessage],
"prices": CartPrices,
"reference_document_links": [
@@ -15727,7 +16254,7 @@ Response
"shipping_addresses": [
NegotiableQuoteShippingAddress
],
- "status": "xyz789",
+ "status": "abc123",
"template_id": 4,
"total_quantity": 987.65
}
@@ -15894,7 +16421,7 @@ Query
Variables
- {"wishlistId": 4, "wishlistItemsIds": ["4"]}
+ {"wishlistId": "4", "wishlistItemsIds": [4]}
@@ -16597,14 +17124,14 @@ Response
"requestNegotiableQuoteTemplateFromQuote": {
"buyer": NegotiableQuoteUser,
"comments": [NegotiableQuoteComment],
- "expiration_date": "abc123",
+ "expiration_date": "xyz789",
"history": [NegotiableQuoteHistoryEntry],
- "is_min_max_qty_used": false,
- "is_virtual": true,
+ "is_min_max_qty_used": true,
+ "is_virtual": false,
"items": [CartItemInterface],
- "max_order_commitment": 987,
+ "max_order_commitment": 123,
"min_order_commitment": 987,
- "name": "xyz789",
+ "name": "abc123",
"notifications": [QuoteTemplateNotificationMessage],
"prices": CartPrices,
"reference_document_links": [
@@ -16614,8 +17141,8 @@ Response
NegotiableQuoteShippingAddress
],
"status": "xyz789",
- "template_id": 4,
- "total_quantity": 123.45
+ "template_id": "4",
+ "total_quantity": 987.65
}
}
}
@@ -16683,7 +17210,7 @@ Variables
Response
- {"data": {"requestPasswordResetEmail": false}}
+ {"data": {"requestPasswordResetEmail": true}}
@@ -16827,7 +17354,7 @@ Variables
Response
- {"data": {"resendConfirmationEmail": true}}
+ {"data": {"resendConfirmationEmail": false}}
@@ -16908,7 +17435,7 @@ Query
Variables
{
- "email": "abc123",
+ "email": "xyz789",
"resetPasswordToken": "xyz789",
"newPassword": "xyz789"
}
@@ -16959,7 +17486,7 @@ Query
Response
- {"data": {"revokeCustomerToken": {"result": true}}}
+ {"data": {"revokeCustomerToken": {"result": false}}}
@@ -17183,6 +17710,81 @@ Variables
Response
{"data": {"setBillingAddressOnCart": {"cart": Cart}}}
+
+
+
+ back to top
+
+
+
+
+ Mutations
+
+
+ setCartAsInactive
+
+
+
+
+ Description
+ Sets the cart as inactive
+
+
+
+
+
+
+ Response
+ Returns a SetCartAsInactiveOutput
+
+
+
+ Arguments
+
+
+
+ Name
+ Description
+
+
+
+
+
+ cartId - String!
+
+ The customer cart ID
+
+
+
+
+
+
+ Example
+
+ Query
+ mutation setCartAsInactive($cartId: String!) {
+ setCartAsInactive(cartId: $cartId) {
+ error
+ success
+ }
+}
+
+
+
+ Variables
+ {"cartId": "xyz789"}
+
+
+
+ Response
+ {
+ "data": {
+ "setCartAsInactive": {
+ "error": "xyz789",
+ "success": true
+ }
+ }
+}
@@ -17793,12 +18395,12 @@ Response
"setNegotiableQuoteTemplateShippingAddress": {
"buyer": NegotiableQuoteUser,
"comments": [NegotiableQuoteComment],
- "expiration_date": "abc123",
+ "expiration_date": "xyz789",
"history": [NegotiableQuoteHistoryEntry],
"is_min_max_qty_used": true,
- "is_virtual": false,
+ "is_virtual": true,
"items": [CartItemInterface],
- "max_order_commitment": 987,
+ "max_order_commitment": 123,
"min_order_commitment": 123,
"name": "abc123",
"notifications": [QuoteTemplateNotificationMessage],
@@ -17810,8 +18412,8 @@ Response
NegotiableQuoteShippingAddress
],
"status": "abc123",
- "template_id": "4",
- "total_quantity": 123.45
+ "template_id": 4,
+ "total_quantity": 987.65
}
}
}
@@ -18080,12 +18682,12 @@ Response
"comments": [NegotiableQuoteComment],
"expiration_date": "xyz789",
"history": [NegotiableQuoteHistoryEntry],
- "is_min_max_qty_used": true,
- "is_virtual": true,
+ "is_min_max_qty_used": false,
+ "is_virtual": false,
"items": [CartItemInterface],
- "max_order_commitment": 987,
+ "max_order_commitment": 123,
"min_order_commitment": 987,
- "name": "xyz789",
+ "name": "abc123",
"notifications": [QuoteTemplateNotificationMessage],
"prices": CartPrices,
"reference_document_links": [
@@ -18095,7 +18697,7 @@ Response
NegotiableQuoteShippingAddress
],
"status": "abc123",
- "template_id": 4,
+ "template_id": "4",
"total_quantity": 987.65
}
}
@@ -18328,7 +18930,7 @@ Variables
Response
- {"data": {"shareGiftRegistry": {"is_shared": false}}}
+ {"data": {"shareGiftRegistry": {"is_shared": true}}}
@@ -18437,7 +19039,7 @@ Response
"is_min_max_qty_used": false,
"is_virtual": true,
"items": [CartItemInterface],
- "max_order_commitment": 987,
+ "max_order_commitment": 123,
"min_order_commitment": 987,
"name": "xyz789",
"notifications": [QuoteTemplateNotificationMessage],
@@ -18448,8 +19050,8 @@ Response
"shipping_addresses": [
NegotiableQuoteShippingAddress
],
- "status": "xyz789",
- "template_id": "4",
+ "status": "abc123",
+ "template_id": 4,
"total_quantity": 987.65
}
}
@@ -18586,71 +19188,6 @@ Variables
Response
{"data": {"syncPaymentOrder": false}}
-
-
-
- back to top
-
-
-
-
- Mutations
-
-
- trackViewedProduct
-
-
-
-
- Description
- Track that a product was viewed in adobe commerce
-
-
-
-
-
-
- Response
- Returns a Boolean
-
-
-
- Arguments
-
-
-
- Name
- Description
-
-
-
-
-
- sku - String!
-
- The sku for a ProductInterface object.
-
-
-
-
-
-
- Example
-
- Query
- mutation trackViewedProduct($sku: String!) {
- trackViewedProduct(sku: $sku)
-}
-
-
-
- Variables
- {"sku": "xyz789"}
-
-
-
- Response
- {"data": {"trackViewedProduct": true}}
@@ -19158,9 +19695,16 @@ Response
-
+
updateCustomerAddress
+
+
+
+ Use updateCustomerAddressV2 instead.
+
+
+
@@ -19244,6 +19788,7 @@ Query
street
suffix
telephone
+ uid
vat_id
}
}
@@ -19259,28 +19804,168 @@ Response
{
"data": {
"updateCustomerAddress": {
- "city": "xyz789",
- "company": "abc123",
+ "city": "abc123",
+ "company": "xyz789",
"country_code": "AF",
"country_id": "xyz789",
"custom_attributes": [CustomerAddressAttribute],
"custom_attributesV2": [AttributeValueInterface],
- "customer_id": 123,
- "default_billing": true,
+ "customer_id": 987,
+ "default_billing": false,
"default_shipping": true,
"extension_attributes": [CustomerAddressAttribute],
- "fax": "xyz789",
+ "fax": "abc123",
"firstname": "xyz789",
- "id": 987,
- "lastname": "abc123",
- "middlename": "xyz789",
+ "id": 123,
+ "lastname": "xyz789",
+ "middlename": "abc123",
"postcode": "xyz789",
"prefix": "abc123",
"region": CustomerAddressRegion,
"region_id": 123,
- "street": ["xyz789"],
+ "street": ["abc123"],
"suffix": "xyz789",
- "telephone": "abc123",
+ "telephone": "xyz789",
+ "uid": 4,
+ "vat_id": "xyz789"
+ }
+ }
+}
+
+
+
+ back to top
+
+
+
+
+ Mutations
+
+
+ updateCustomerAddressV2
+
+
+
+
+ Description
+ Update the billing or shipping address of a customer or guest.
+
+
+
+
+
+
+ Response
+ Returns a CustomerAddress
+
+
+
+ Arguments
+
+
+
+ Name
+ Description
+
+
+
+
+
+ uid - ID!
+
+ The unique ID of the customer address.
+
+
+
+ input - CustomerAddressInput
+
+ An input object that contains changes to the customer address.
+
+
+
+
+
+
+ Example
+
+ Query
+ mutation updateCustomerAddressV2(
+ $uid: ID!,
+ $input: CustomerAddressInput
+) {
+ updateCustomerAddressV2(
+ uid: $uid,
+ input: $input
+ ) {
+ city
+ company
+ country_code
+ country_id
+ custom_attributes {
+ ...CustomerAddressAttributeFragment
+ }
+ custom_attributesV2 {
+ ...AttributeValueInterfaceFragment
+ }
+ customer_id
+ default_billing
+ default_shipping
+ extension_attributes {
+ ...CustomerAddressAttributeFragment
+ }
+ fax
+ firstname
+ id
+ lastname
+ middlename
+ postcode
+ prefix
+ region {
+ ...CustomerAddressRegionFragment
+ }
+ region_id
+ street
+ suffix
+ telephone
+ uid
+ vat_id
+ }
+}
+
+
+
+ Variables
+ {"uid": 4, "input": CustomerAddressInput}
+
+
+
+ Response
+ {
+ "data": {
+ "updateCustomerAddressV2": {
+ "city": "abc123",
+ "company": "abc123",
+ "country_code": "AF",
+ "country_id": "abc123",
+ "custom_attributes": [CustomerAddressAttribute],
+ "custom_attributesV2": [AttributeValueInterface],
+ "customer_id": 987,
+ "default_billing": false,
+ "default_shipping": true,
+ "extension_attributes": [CustomerAddressAttribute],
+ "fax": "abc123",
+ "firstname": "xyz789",
+ "id": 123,
+ "lastname": "xyz789",
+ "middlename": "abc123",
+ "postcode": "xyz789",
+ "prefix": "xyz789",
+ "region": CustomerAddressRegion,
+ "region_id": 987,
+ "street": ["abc123"],
+ "suffix": "xyz789",
+ "telephone": "xyz789",
+ "uid": "4",
"vat_id": "xyz789"
}
}
@@ -19361,8 +20046,8 @@ Query
Variables
{
- "email": "xyz789",
- "password": "abc123"
+ "email": "abc123",
+ "password": "xyz789"
}
@@ -19692,7 +20377,7 @@ Query
Variables
{
- "giftRegistryUid": "4",
+ "giftRegistryUid": 4,
"registrants": [UpdateGiftRegistryRegistrantInput]
}
@@ -20038,12 +20723,12 @@ Response
"applies_to_roles": [CompanyRole],
"approver_roles": [CompanyRole],
"condition": PurchaseOrderApprovalRuleConditionInterface,
- "created_at": "abc123",
+ "created_at": "xyz789",
"created_by": "xyz789",
- "description": "abc123",
- "name": "abc123",
+ "description": "xyz789",
+ "name": "xyz789",
"status": "ENABLED",
- "uid": "4",
+ "uid": 4,
"updated_at": "xyz789"
}
}
@@ -20125,7 +20810,7 @@ Query
Variables
{
- "requisitionListUid": "4",
+ "requisitionListUid": 4,
"input": UpdateRequisitionListInput
}
@@ -20315,7 +21000,7 @@ Query
Variables
{
- "wishlistId": "4",
+ "wishlistId": 4,
"name": "xyz789",
"visibility": "PUBLIC"
}
@@ -20326,8 +21011,8 @@ Response
{
"data": {
"updateWishlist": {
- "name": "xyz789",
- "uid": 4,
+ "name": "abc123",
+ "uid": "4",
"visibility": "PUBLIC"
}
}
@@ -20450,7 +21135,7 @@ Fields
Example
- {"template_id": "4"}
+ {"template_id": 4}
@@ -20498,7 +21183,7 @@ Fields
Example
{
- "cart_id": "xyz789",
+ "cart_id": "abc123",
"cart_items": [BundleProductCartItemInput]
}
@@ -20674,7 +21359,7 @@ Fields
Example
{
- "cart_id": "xyz789",
+ "cart_id": "abc123",
"cart_items": [DownloadableProductCartItemInput]
}
@@ -20779,9 +21464,9 @@ Example
"dynamic_attributes": [
GiftRegistryDynamicAttributeInput
],
- "email": "xyz789",
- "firstname": "xyz789",
- "lastname": "xyz789"
+ "email": "abc123",
+ "firstname": "abc123",
+ "lastname": "abc123"
}
@@ -20917,7 +21602,55 @@ Fields
Example
- {"products": [4], "uid": "4"}
+ {"products": ["4"], "uid": 4}
+
+
+
+ back to top
+
+
+
+
+ Types
+
+ AddProductsToNewCartOutput
+
+
+
+ Description
+ Contains details about the cart after adding products to it.
+
+
+ Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+ cart - Cart
+
+ The cart after products have been added.
+
+
+ user_errors - [CartUserInputError]
+
+ Contains errors encountered while adding an item to the cart.
+
+
+
+
+
+
+
+ Example
+ {
+ "cart": Cart,
+ "user_errors": [CartUserInputError]
+}
@@ -21054,7 +21787,7 @@ Fields
Example
{
"comment": "abc123",
- "purchase_order_uid": "4"
+ "purchase_order_uid": 4
}
@@ -21150,7 +21883,7 @@ Fields
Example
{
"cart_id": "abc123",
- "purchase_order_uid": 4,
+ "purchase_order_uid": "4",
"replace_existing_cart_items": false
}
@@ -21198,7 +21931,7 @@ Fields
Example
{
- "message": "abc123",
+ "message": "xyz789",
"type": "OUT_OF_STOCK"
}
@@ -21363,7 +22096,7 @@ Fields
Example
{
- "comment_text": "abc123",
+ "comment_text": "xyz789",
"return_uid": "4"
}
@@ -21558,7 +22291,7 @@ Fields
Example
{
- "cart_id": "abc123",
+ "cart_id": "xyz789",
"cart_items": [SimpleProductCartItemInput]
}
@@ -21744,7 +22477,7 @@ Example
"add_wishlist_items_to_cart_user_errors": [
WishlistCartUserInputError
],
- "status": false,
+ "status": true,
"wishlist": Wishlist
}
@@ -21808,10 +22541,10 @@ Fields
Example
{
"attribute_code": "xyz789",
- "count": 123,
- "label": "xyz789",
+ "count": 987,
+ "label": "abc123",
"options": [AggregationOption],
- "position": 123
+ "position": 987
}
@@ -21865,7 +22598,7 @@ Example
{
"count": 987,
"label": "abc123",
- "value": "abc123"
+ "value": "xyz789"
}
@@ -21935,7 +22668,7 @@ Possible Types
Example
{
"count": 987,
- "label": "xyz789",
+ "label": "abc123",
"value": "abc123"
}
@@ -21978,7 +22711,7 @@ Fields
Example
- {"includeDirectChildrenOnly": false}
+ {"includeDirectChildrenOnly": true}
@@ -22094,8 +22827,8 @@ Example
"button_styles": ButtonStyles,
"code": "abc123",
"is_visible": true,
- "payment_intent": "abc123",
- "payment_source": "xyz789",
+ "payment_intent": "xyz789",
+ "payment_source": "abc123",
"sdk_params": [SDKParams],
"sort_order": "abc123",
"title": "abc123"
@@ -22154,8 +22887,8 @@ Fields
Example
{
"payment_source": "xyz789",
- "payments_order_id": "abc123",
- "paypal_order_id": "abc123"
+ "payments_order_id": "xyz789",
+ "paypal_order_id": "xyz789"
}
@@ -22196,7 +22929,7 @@ Fields
Example
- {"code": "xyz789"}
+ {"code": "abc123"}
@@ -22358,7 +23091,7 @@ Fields
Example
{
- "cart_id": "xyz789",
+ "cart_id": "abc123",
"coupon_code": "xyz789"
}
@@ -22503,7 +23236,7 @@ Fields
Example
{
- "cart_id": "xyz789",
+ "cart_id": "abc123",
"coupon_codes": ["xyz789"],
"type": "APPEND"
}
@@ -22555,7 +23288,7 @@ Fields
Example
{
"cart_id": "xyz789",
- "gift_card_code": "abc123"
+ "gift_card_code": "xyz789"
}
@@ -22725,7 +23458,7 @@ Fields
Example
- {"cart_id": "abc123"}
+ {"cart_id": "xyz789"}
@@ -22812,7 +23545,7 @@ Fields
Example
- {"radius": 987, "search_term": "xyz789"}
+ {"radius": 987, "search_term": "abc123"}
@@ -22857,7 +23590,7 @@ Fields
Example
- {"compare_list": CompareList, "result": false}
+ {"compare_list": CompareList, "result": true}
@@ -23107,18 +23840,18 @@ Fields
Example
{
- "is_comparable": false,
+ "is_comparable": true,
"is_filterable": true,
- "is_filterable_in_search": false,
- "is_html_allowed_on_front": false,
- "is_searchable": true,
- "is_used_for_customer_segment": false,
+ "is_filterable_in_search": true,
+ "is_html_allowed_on_front": true,
+ "is_searchable": false,
+ "is_used_for_customer_segment": true,
"is_used_for_price_rules": true,
- "is_used_for_promo_rules": true,
+ "is_used_for_promo_rules": false,
"is_visible_in_advanced_search": false,
"is_visible_on_front": true,
- "is_wysiwyg_enabled": true,
- "used_in_product_listing": true
+ "is_wysiwyg_enabled": false,
+ "used_in_product_listing": false
}
@@ -23314,8 +24047,8 @@ Fields
Example
{
- "attribute_code": "xyz789",
- "entity_type": "xyz789"
+ "attribute_code": "abc123",
+ "entity_type": "abc123"
}
@@ -23357,7 +24090,7 @@ Fields
Example
- {"value": "xyz789"}
+ {"value": "abc123"}
@@ -23443,8 +24176,8 @@ Example
"entity_type": "CATALOG_PRODUCT",
"frontend_class": "abc123",
"frontend_input": "BOOLEAN",
- "is_required": false,
- "is_unique": false,
+ "is_required": true,
+ "is_unique": true,
"label": "xyz789",
"options": [CustomAttributeOptionInterface]
}
@@ -23493,7 +24226,7 @@ Fields
Example
{
- "message": "xyz789",
+ "message": "abc123",
"type": "ENTITY_NOT_FOUND"
}
@@ -23600,7 +24333,7 @@ Fields
Example
{
- "label": "abc123",
+ "label": "xyz789",
"value": "xyz789"
}
@@ -23654,8 +24387,8 @@ Fields
Example
{
"is_default": true,
- "label": "abc123",
- "value": "abc123"
+ "label": "xyz789",
+ "value": "xyz789"
}
@@ -23699,7 +24432,7 @@ Fields
Example
{
"label": "xyz789",
- "value": "abc123"
+ "value": "xyz789"
}
@@ -23847,7 +24580,10 @@ Fields
Example
- {"code": 4, "value": "abc123"}
+ {
+ "code": "4",
+ "value": "xyz789"
+}
@@ -23901,7 +24637,7 @@ Fields
Example
{
- "attribute_code": "abc123",
+ "attribute_code": "xyz789",
"selected_options": [AttributeInputSelectedOption],
"value": "abc123"
}
@@ -23955,6 +24691,11 @@ Possible Types
+
+
+
+
+
@@ -24103,7 +24844,7 @@ Fields
Example
- {"code": "AFN", "symbol": "xyz789"}
+ {"code": "AFN", "symbol": "abc123"}
@@ -24155,7 +24896,7 @@ Fields
Example
{
"code": "xyz789",
- "is_deferred": true,
+ "is_deferred": false,
"title": "abc123"
}
@@ -24248,11 +24989,11 @@ Example
"amount": Money,
"available": false,
"base_amount": Money,
- "carrier_code": "xyz789",
+ "carrier_code": "abc123",
"carrier_title": "abc123",
"error_message": "xyz789",
- "method_code": "xyz789",
- "method_title": "xyz789",
+ "method_code": "abc123",
+ "method_title": "abc123",
"price_excl_tax": Money,
"price_incl_tax": Money
}
@@ -24347,6 +25088,12 @@ Fields
An ID from the customer's address book that uniquely identifies the address to be used for billing.
+
+
+ customer_address_uid - ID
+
+ The unique ID from the customer's address book that uniquely identifies the address to be used for billing.
+
same_as_shipping - Boolean
@@ -24369,6 +25116,7 @@ Example
{
"address": CartAddressInput,
"customer_address_id": 123,
+ "customer_address_uid": 4,
"same_as_shipping": true,
"use_for_shipping": true
}
@@ -24443,11 +25191,11 @@ Fields
Example
{
- "address_line_1": "xyz789",
- "address_line_2": "xyz789",
- "city": "abc123",
- "country_code": "xyz789",
- "postal_code": "xyz789",
+ "address_line_1": "abc123",
+ "address_line_2": "abc123",
+ "city": "xyz789",
+ "country_code": "abc123",
+ "postal_code": "abc123",
"region": "xyz789"
}
@@ -24497,6 +25245,11 @@ Fields
The custom attribute values of the billing or shipping address.
+
+ customer_address_uid - ID
+
+ The unique ID from the customer's address book that uniquely identifies the address.
+
customer_notes - String
@@ -24515,9 +25268,10 @@ Fields
The first name of the customer or guest.
- id - Int
+ id - Int
+
+ Id of the customer address. Use customer_address_uid instead.
- Id of the customer address.
lastname - String!
@@ -24560,9 +25314,9 @@ Fields
The telephone number for the billing or shipping address.
- uid - String!
+ uid - ID!
- The unique id of the customer address.
+ The unique id of the customer cart address.
vat_id - String
@@ -24577,23 +25331,24 @@ Fields
Example
{
- "city": "xyz789",
+ "city": "abc123",
"company": "xyz789",
"country": CartAddressCountry,
"custom_attributes": [AttributeValueInterface],
+ "customer_address_uid": "4",
"customer_notes": "abc123",
"fax": "abc123",
- "firstname": "xyz789",
+ "firstname": "abc123",
"id": 123,
"lastname": "abc123",
"middlename": "abc123",
"postcode": "xyz789",
- "prefix": "abc123",
+ "prefix": "xyz789",
"region": CartAddressRegion,
"street": ["xyz789"],
- "suffix": "abc123",
- "telephone": "abc123",
- "uid": "xyz789",
+ "suffix": "xyz789",
+ "telephone": "xyz789",
+ "uid": "4",
"vat_id": "xyz789"
}
@@ -24615,11 +25370,6 @@ Description
-
- Example
- true
-
-
back to top
@@ -24663,8 +25413,8 @@ Fields
Example
{
- "device_data": "xyz789",
- "public_hash": "abc123"
+ "device_data": "abc123",
+ "public_hash": "xyz789"
}
@@ -24717,7 +25467,7 @@ Example
{
"device_data": "xyz789",
"is_active_payment_token_enabler": true,
- "payment_method_nonce": "abc123"
+ "payment_method_nonce": "xyz789"
}
@@ -24834,7 +25584,7 @@ Fields
Example
{
"category_id": 987,
- "category_level": 123,
+ "category_level": 987,
"category_name": "xyz789",
"category_uid": 4,
"category_url_key": "abc123",
@@ -24974,8 +25724,8 @@ Example
"errors": [CartItemError],
"gift_message": GiftMessage,
"gift_wrapping": GiftWrapping,
- "id": "xyz789",
- "is_available": true,
+ "id": "abc123",
+ "is_available": false,
"max_qty": 987.65,
"min_qty": 987.65,
"not_available_message": "xyz789",
@@ -25067,7 +25817,7 @@ Example
"order_item": OrderItemInterface,
"product_name": "abc123",
"product_sale_price": Money,
- "product_sku": "xyz789",
+ "product_sku": "abc123",
"quantity_refunded": 123.45
}
@@ -25147,12 +25897,12 @@ Example
{
"bundle_options": [ItemSelectedBundleOption],
"discounts": [Discount],
- "id": "4",
+ "id": 4,
"order_item": OrderItemInterface,
- "product_name": "abc123",
+ "product_name": "xyz789",
"product_sale_price": Money,
- "product_sku": "xyz789",
- "quantity_invoiced": 987.65
+ "product_sku": "abc123",
+ "quantity_invoiced": 123.45
}
@@ -25235,13 +25985,13 @@ Fields
Example
{
- "option_id": 987,
+ "option_id": 123,
"options": [BundleItemOption],
"position": 123,
"price_range": PriceRange,
"required": false,
"sku": "abc123",
- "title": "abc123",
+ "title": "xyz789",
"type": "abc123",
"uid": 4
}
@@ -25337,17 +26087,17 @@ Fields
Example
{
- "can_change_quantity": false,
+ "can_change_quantity": true,
"id": 123,
"is_default": true,
"label": "abc123",
- "position": 123,
+ "position": 987,
"price": 123.45,
"price_type": "FIXED",
"product": ProductInterface,
- "qty": 123.45,
- "quantity": 123.45,
- "uid": "4"
+ "qty": 987.65,
+ "quantity": 987.65,
+ "uid": 4
}
@@ -25403,8 +26153,8 @@ Fields
Example
{
"id": 123,
- "quantity": 987.65,
- "value": ["xyz789"]
+ "quantity": 123.45,
+ "value": ["abc123"]
}
@@ -25563,7 +26313,7 @@ Example
{
"bundle_options": [ItemSelectedBundleOption],
"discounts": [Discount],
- "eligible_for_return": true,
+ "eligible_for_return": false,
"entered_options": [OrderItemOption],
"gift_message": GiftMessage,
"gift_wrapping": GiftWrapping,
@@ -25573,14 +26323,14 @@ Example
"product": ProductInterface,
"product_name": "xyz789",
"product_sale_price": Money,
- "product_sku": "abc123",
+ "product_sku": "xyz789",
"product_type": "xyz789",
- "product_url_key": "xyz789",
- "quantity_canceled": 987.65,
- "quantity_invoiced": 123.45,
- "quantity_ordered": 123.45,
- "quantity_refunded": 987.65,
- "quantity_return_requested": 123.45,
+ "product_url_key": "abc123",
+ "quantity_canceled": 123.45,
+ "quantity_invoiced": 987.65,
+ "quantity_ordered": 987.65,
+ "quantity_refunded": 123.45,
+ "quantity_return_requested": 987.65,
"quantity_returned": 123.45,
"quantity_shipped": 123.45,
"selected_options": [OrderItemOption],
@@ -25613,13 +26363,6 @@ Fields
-
- activity - String
-
-
- Use the custom_attributes field instead.
-
-
attribute_set_id - Int
@@ -25636,27 +26379,6 @@ Fields
The categories assigned to a product.
-
- category_gear - String
-
-
- Use the custom_attributes field instead.
-
-
-
- climate - String
-
-
- Use the custom_attributes field instead.
-
-
-
- collar - String
-
-
- Use the custom_attributes field instead.
-
-
color - Int
@@ -25718,41 +26440,6 @@ filters
Indicates whether the bundle product has a dynamically calculated weight.
-
- eco_collection - Int
-
-
- Use the custom_attributes field instead.
-
-
-
- erin_recommends - Int
-
-
- Use the custom_attributes field instead.
-
-
-
- features_bags - String
-
-
- Use the custom_attributes field instead.
-
-
-
- format - Int
-
-
- Use the custom_attributes field instead.
-
-
-
- gender - String
-
-
- Use the custom_attributes field instead.
-
-
gift_message_available - Boolean!
@@ -25795,13 +26482,6 @@ filters
A number representing the product's manufacturer. Use the custom_attributes field instead.
-
- material - String
-
-
- Use the custom_attributes field instead.
-
-
max_sale_qty - Float
@@ -25843,13 +26523,6 @@ filters
The product name. Customers use this name to identify the product.
-
- new - Int
-
-
- Use the custom_attributes field instead.
-
-
new_from_date - String
@@ -25875,20 +26548,6 @@ filters
If the product has multiple options, determines where they appear on the product page.
-
- pattern - String
-
-
- Use the custom_attributes field instead.
-
-
-
- performance_fabric - Int
-
-
- Use the custom_attributes field instead.
-
-
price - ProductPrices
@@ -25920,13 +26579,6 @@ filters
An array of ProductLinks objects.
-
- purpose - Int
-
-
- Use the custom_attributes field instead.
-
-
quantity - Float
@@ -25981,18 +26633,6 @@ currentPage
-
- rules - [CatalogRule]
-
- Provides applied catalog rules in the current active cart
-
-
- sale - Int
-
-
- Use the custom_attributes field instead.
-
-
ship_bundle_items - ShipBundleItemsEnum
@@ -26003,25 +26643,11 @@ currentPage
A short description of the product. Its use depends on the theme.
-
- size - Int
-
-
- Use the custom_attributes field instead.
-
-
sku - String
A number or code assigned to a product to identify the product, options, price, and manufacturer.
-
- sleeve - String
-
-
- Use the custom_attributes field instead.
-
-
small_image - ProductImage
@@ -26053,34 +26679,6 @@ currentPage
Stock status of the product
-
- strap_bags - String
-
-
- Use the custom_attributes field instead.
-
-
-
- style_bags - String
-
-
- Use the custom_attributes field instead.
-
-
-
- style_bottom - String
-
-
- Use the custom_attributes field instead.
-
-
-
- style_general - String
-
-
- Use the custom_attributes field instead.
-
-
swatch_image - String
@@ -26171,59 +26769,45 @@ currentPage
Example
{
- "activity": "abc123",
"attribute_set_id": 123,
- "canonical_url": "xyz789",
+ "canonical_url": "abc123",
"categories": [CategoryInterface],
- "category_gear": "abc123",
- "climate": "abc123",
- "collar": "abc123",
- "color": 987,
+ "color": 123,
"country_of_manufacture": "xyz789",
"created_at": "xyz789",
"crosssell_products": [ProductInterface],
"custom_attributesV2": ProductCustomAttributes,
"description": ComplexTextValue,
"dynamic_price": false,
- "dynamic_sku": true,
+ "dynamic_sku": false,
"dynamic_weight": false,
- "eco_collection": 987,
- "erin_recommends": 123,
- "features_bags": "abc123",
- "format": 123,
- "gender": "abc123",
"gift_message_available": false,
- "gift_wrapping_available": true,
+ "gift_wrapping_available": false,
"gift_wrapping_price": Money,
"id": 123,
"image": ProductImage,
- "is_returnable": "xyz789",
+ "is_returnable": "abc123",
"items": [BundleItem],
"manufacturer": 123,
- "material": "abc123",
"max_sale_qty": 987.65,
"media_gallery": [MediaGalleryInterface],
"media_gallery_entries": [MediaGalleryEntry],
- "meta_description": "abc123",
+ "meta_description": "xyz789",
"meta_keyword": "abc123",
- "meta_title": "xyz789",
- "min_sale_qty": 123.45,
- "name": "xyz789",
- "new": 987,
- "new_from_date": "abc123",
+ "meta_title": "abc123",
+ "min_sale_qty": 987.65,
+ "name": "abc123",
+ "new_from_date": "xyz789",
"new_to_date": "xyz789",
"only_x_left_in_stock": 987.65,
"options": [CustomizableOptionInterface],
"options_container": "xyz789",
- "pattern": "abc123",
- "performance_fabric": 987,
"price": ProductPrices,
"price_details": PriceDetails,
"price_range": PriceRange,
"price_tiers": [TierPrice],
"price_view": "PRICE_RANGE",
"product_links": [ProductLinksInterface],
- "purpose": 987,
"quantity": 123.45,
"rating_summary": 987.65,
"redirect_code": 123,
@@ -26231,38 +26815,30 @@ Example
"relative_url": "abc123",
"review_count": 987,
"reviews": ProductReviews,
- "rules": [CatalogRule],
- "sale": 987,
"ship_bundle_items": "TOGETHER",
"short_description": ComplexTextValue,
- "size": 987,
"sku": "xyz789",
- "sleeve": "xyz789",
"small_image": ProductImage,
"special_from_date": "xyz789",
"special_price": 987.65,
"special_to_date": "xyz789",
- "staged": false,
+ "staged": true,
"stock_status": "IN_STOCK",
- "strap_bags": "xyz789",
- "style_bags": "abc123",
- "style_bottom": "xyz789",
- "style_general": "xyz789",
- "swatch_image": "abc123",
+ "swatch_image": "xyz789",
"thumbnail": ProductImage,
"tier_price": 123.45,
"tier_prices": [ProductTierPrices],
"type": "CMS_PAGE",
- "type_id": "xyz789",
+ "type_id": "abc123",
"uid": "4",
- "updated_at": "abc123",
+ "updated_at": "xyz789",
"upsell_products": [ProductInterface],
- "url_key": "abc123",
+ "url_key": "xyz789",
"url_path": "xyz789",
"url_rewrites": [UrlRewrite],
"url_suffix": "xyz789",
"websites": [Website],
- "weight": 987.65
+ "weight": 123.45
}
@@ -26385,7 +26961,7 @@ Example
"customizable_options": [SelectedCustomizableOption],
"product": ProductInterface,
"quantity": 123.45,
- "uid": 4
+ "uid": "4"
}
@@ -26460,7 +27036,7 @@ Example
"bundle_options": [ItemSelectedBundleOption],
"id": "4",
"order_item": OrderItemInterface,
- "product_name": "xyz789",
+ "product_name": "abc123",
"product_sale_price": Money,
"product_sku": "xyz789",
"quantity_shipped": 987.65
@@ -26538,8 +27114,8 @@ Example
"added_at": "abc123",
"bundle_options": [SelectedBundleOption],
"customizable_options": [SelectedCustomizableOption],
- "description": "abc123",
- "id": "4",
+ "description": "xyz789",
+ "id": 4,
"product": ProductInterface,
"quantity": 123.45
}
@@ -26609,11 +27185,11 @@ Fields
Example
{
- "color": "xyz789",
+ "color": "abc123",
"height": 987,
"label": "abc123",
- "layout": "abc123",
- "shape": "xyz789",
+ "layout": "xyz789",
+ "shape": "abc123",
"tagline": true,
"use_default_height": true
}
@@ -26832,7 +27408,7 @@ Fields
Example
{
"order_id": "4",
- "reason": "abc123"
+ "reason": "xyz789"
}
@@ -26925,7 +27501,7 @@ Fields
Example
- {"description": "abc123"}
+ {"description": "xyz789"}
@@ -26984,9 +27560,9 @@ Example
{
"bin_details": CardBin,
"card_expiry_month": "abc123",
- "card_expiry_year": "abc123",
- "last_digits": "xyz789",
- "name": "xyz789"
+ "card_expiry_year": "xyz789",
+ "last_digits": "abc123",
+ "name": "abc123"
}
@@ -27023,7 +27599,7 @@ Fields
Example
- {"bin": "abc123"}
+ {"bin": "xyz789"}
@@ -27072,7 +27648,7 @@ Fields
Example
{
"billing_address": BillingAddressPaymentSourceInput,
- "name": "abc123"
+ "name": "xyz789"
}
@@ -27124,7 +27700,7 @@ Fields
Example
{
- "brand": "xyz789",
+ "brand": "abc123",
"expiry": "xyz789",
"last_digits": "xyz789"
}
@@ -27271,7 +27847,7 @@ sort Indicates whether the shopper requested a printed card for the cart.
- rules - [CartRule]
+ rules - [CartRuleStorefront]
Provides applied cart rules in the current active cart
@@ -27306,20 +27882,20 @@ Example
"available_gift_wrappings": [GiftWrapping],
"available_payment_methods": [AvailablePaymentMethod],
"billing_address": BillingCartAddress,
- "email": "xyz789",
+ "email": "abc123",
"gift_message": GiftMessage,
"gift_receipt_included": false,
"gift_wrapping": GiftWrapping,
- "id": "4",
- "is_virtual": false,
+ "id": 4,
+ "is_virtual": true,
"items": [CartItemInterface],
"itemsV2": CartItems,
"prices": CartPrices,
- "printed_card_included": true,
- "rules": [CartRule],
+ "printed_card_included": false,
+ "rules": [CartRuleStorefront],
"selected_payment_method": SelectedPaymentMethod,
"shipping_addresses": [ShippingCartAddress],
- "total_quantity": 987.65
+ "total_quantity": 123.45
}
@@ -27488,7 +28064,7 @@ Fields
- telephone - String
+ telephone - String!
The telephone number for the billing or shipping address.
@@ -27508,19 +28084,19 @@ Example
{
"city": "abc123",
"company": "xyz789",
- "country_code": "xyz789",
+ "country_code": "abc123",
"custom_attributes": [AttributeValueInput],
"fax": "xyz789",
"firstname": "xyz789",
- "lastname": "abc123",
- "middlename": "xyz789",
+ "lastname": "xyz789",
+ "middlename": "abc123",
"postcode": "xyz789",
"prefix": "xyz789",
- "region": "xyz789",
- "region_id": 123,
- "save_in_address_book": true,
+ "region": "abc123",
+ "region_id": 987,
+ "save_in_address_book": false,
"street": ["abc123"],
- "suffix": "abc123",
+ "suffix": "xyz789",
"telephone": "xyz789",
"vat_id": "xyz789"
}
@@ -27567,6 +28143,11 @@ Fields
The custom attribute values of the billing or shipping address.
+
+ customer_address_uid - ID
+
+ The unique ID from the customer's address book that uniquely identifies the address.
+
fax - String
@@ -27578,9 +28159,10 @@ Fields
The first name of the customer or guest.
- id - Int
+ id - Int
+
+ Id of the customer address. Use customer_address_uid instead.
- Id of the customer address.
lastname - String!
@@ -27623,9 +28205,9 @@ Fields
The telephone number for the billing or shipping address.
- uid - String!
+ uid - ID!
- The unique id of the customer address.
+ The unique id of the customer cart address.
vat_id - String
@@ -27662,23 +28244,24 @@ Possible Types
Example
{
- "city": "abc123",
+ "city": "xyz789",
"company": "abc123",
"country": CartAddressCountry,
"custom_attributes": [AttributeValueInterface],
+ "customer_address_uid": 4,
"fax": "xyz789",
"firstname": "xyz789",
"id": 987,
- "lastname": "abc123",
- "middlename": "abc123",
- "postcode": "xyz789",
- "prefix": "abc123",
+ "lastname": "xyz789",
+ "middlename": "xyz789",
+ "postcode": "abc123",
+ "prefix": "xyz789",
"region": CartAddressRegion,
- "street": ["abc123"],
- "suffix": "abc123",
- "telephone": "abc123",
- "uid": "xyz789",
- "vat_id": "abc123"
+ "street": ["xyz789"],
+ "suffix": "xyz789",
+ "telephone": "xyz789",
+ "uid": 4,
+ "vat_id": "xyz789"
}
@@ -27730,8 +28313,8 @@ Fields
Example
{
- "code": "xyz789",
- "label": "xyz789",
+ "code": "abc123",
+ "label": "abc123",
"region_id": 123
}
@@ -27988,7 +28571,7 @@ Example
"entered_options": [EnteredOptionInput],
"parent_sku": "abc123",
"quantity": 123.45,
- "selected_options": [4],
+ "selected_options": ["4"],
"sku": "abc123"
}
@@ -28114,12 +28697,12 @@ Possible Types
-
+
-
+
@@ -28137,16 +28720,16 @@ Example
{
"discount": [Discount],
"errors": [CartItemError],
- "id": "abc123",
- "is_available": true,
+ "id": "xyz789",
+ "is_available": false,
"max_qty": 123.45,
- "min_qty": 123.45,
+ "min_qty": 987.65,
"not_available_message": "xyz789",
"note_from_buyer": [ItemNote],
"note_from_seller": [ItemNote],
"prices": CartItemPrices,
"product": ProductInterface,
- "quantity": 123.45,
+ "quantity": 987.65,
"uid": 4
}
@@ -28299,7 +28882,7 @@ Fields
Example
- {"cart_item_id": 123, "quantity": 123.45}
+ {"cart_item_id": 987, "quantity": 987.65}
@@ -28351,7 +28934,7 @@ Fields
Example
{
"type": "FIXED",
- "units": "abc123",
+ "units": "xyz789",
"value": 123.45
}
@@ -28426,10 +29009,10 @@ Fields
Example
{
"cart_item_id": 123,
- "cart_item_uid": "4",
+ "cart_item_uid": 4,
"customizable_options": [CustomizableOptionInput],
"gift_message": GiftMessageInput,
- "gift_wrapping_id": "4",
+ "gift_wrapping_id": 4,
"quantity": 123.45
}
@@ -28580,11 +29163,11 @@ Example
back to top
-
+
- CartRule
+ CartRuleStorefront
@@ -28598,9 +29181,9 @@ Fields
- name - String!
+ uid - ID!
- Name of the cart price rule
+ The unique ID for a CartRule object.
@@ -28609,7 +29192,7 @@ Fields
Example
- {"name": "abc123"}
+ {"uid": 4}
@@ -29025,66 +29608,30 @@ Fields
Example
{
"apply_to": ["SIMPLE"],
- "code": 4,
+ "code": "4",
"default_value": "xyz789",
"entity_type": "CATALOG_PRODUCT",
- "frontend_class": "abc123",
+ "frontend_class": "xyz789",
"frontend_input": "BOOLEAN",
- "is_comparable": false,
- "is_filterable": false,
+ "is_comparable": true,
+ "is_filterable": true,
"is_filterable_in_search": false,
- "is_html_allowed_on_front": true,
- "is_required": false,
+ "is_html_allowed_on_front": false,
+ "is_required": true,
"is_searchable": false,
- "is_unique": false,
- "is_used_for_price_rules": true,
- "is_used_for_promo_rules": true,
- "is_visible_in_advanced_search": false,
+ "is_unique": true,
+ "is_used_for_price_rules": false,
+ "is_used_for_promo_rules": false,
+ "is_visible_in_advanced_search": true,
"is_visible_on_front": false,
"is_wysiwyg_enabled": false,
"label": "xyz789",
"options": [CustomAttributeOptionInterface],
"swatch_input_type": "BOOLEAN",
- "update_product_preview_image": false,
+ "update_product_preview_image": true,
"use_product_image_for_swatch": false,
"used_in_product_listing": false
}
-
-
-
- back to top
-
-
-
-
- Types
-
- CatalogRule
-
-
-
- Fields
-
-
-
- Field Name
- Description
-
-
-
-
- name - String!
-
- Name of the catalog rule
-
-
-
-
-
-
-
- Example
- {"name": "xyz789"}
@@ -29427,39 +29974,39 @@ Possible Types
Example
{
- "automatic_sorting": "abc123",
- "available_sort_by": ["abc123"],
+ "automatic_sorting": "xyz789",
+ "available_sort_by": ["xyz789"],
"breadcrumbs": [Breadcrumb],
"canonical_url": "xyz789",
"children_count": "abc123",
"cms_block": CmsBlock,
- "created_at": "abc123",
- "custom_layout_update_file": "abc123",
- "default_sort_by": "abc123",
- "description": "xyz789",
- "display_mode": "abc123",
- "filter_price_range": 987.65,
+ "created_at": "xyz789",
+ "custom_layout_update_file": "xyz789",
+ "default_sort_by": "xyz789",
+ "description": "abc123",
+ "display_mode": "xyz789",
+ "filter_price_range": 123.45,
"id": 987,
- "image": "abc123",
- "include_in_menu": 987,
- "is_anchor": 123,
- "landing_page": 123,
+ "image": "xyz789",
+ "include_in_menu": 123,
+ "is_anchor": 987,
+ "landing_page": 987,
"level": 987,
- "meta_description": "xyz789",
- "meta_keywords": "abc123",
- "meta_title": "abc123",
- "name": "abc123",
- "path": "abc123",
+ "meta_description": "abc123",
+ "meta_keywords": "xyz789",
+ "meta_title": "xyz789",
+ "name": "xyz789",
+ "path": "xyz789",
"path_in_store": "xyz789",
"position": 987,
"product_count": 987,
"products": CategoryProducts,
- "staged": false,
- "uid": "4",
+ "staged": true,
+ "uid": 4,
"updated_at": "abc123",
- "url_key": "abc123",
+ "url_key": "xyz789",
"url_path": "xyz789",
- "url_suffix": "xyz789"
+ "url_suffix": "abc123"
}
@@ -29567,7 +30114,7 @@ Example
{
"items": [CategoryTree],
"page_info": SearchResultPageInfo,
- "total_count": 987
+ "total_count": 123
}
@@ -29829,43 +30376,43 @@ sort
Example
{
- "automatic_sorting": "abc123",
+ "automatic_sorting": "xyz789",
"available_sort_by": ["abc123"],
"breadcrumbs": [Breadcrumb],
- "canonical_url": "xyz789",
+ "canonical_url": "abc123",
"children": [CategoryTree],
"children_count": "abc123",
"cms_block": CmsBlock,
- "created_at": "abc123",
+ "created_at": "xyz789",
"custom_layout_update_file": "abc123",
"default_sort_by": "xyz789",
- "description": "abc123",
- "display_mode": "xyz789",
- "filter_price_range": 123.45,
- "id": 123,
+ "description": "xyz789",
+ "display_mode": "abc123",
+ "filter_price_range": 987.65,
+ "id": 987,
"image": "abc123",
- "include_in_menu": 987,
- "is_anchor": 123,
- "landing_page": 123,
+ "include_in_menu": 123,
+ "is_anchor": 987,
+ "landing_page": 987,
"level": 987,
- "meta_description": "xyz789",
+ "meta_description": "abc123",
"meta_keywords": "xyz789",
- "meta_title": "xyz789",
+ "meta_title": "abc123",
"name": "xyz789",
"path": "abc123",
"path_in_store": "abc123",
"position": 987,
"product_count": 123,
"products": CategoryProducts,
- "redirect_code": 123,
- "relative_url": "xyz789",
+ "redirect_code": 987,
+ "relative_url": "abc123",
"staged": true,
"type": "CMS_PAGE",
"uid": 4,
- "updated_at": "abc123",
+ "updated_at": "xyz789",
"url_key": "abc123",
- "url_path": "abc123",
- "url_suffix": "abc123"
+ "url_path": "xyz789",
+ "url_suffix": "xyz789"
}
@@ -29937,13 +30484,13 @@ Fields
Example
{
- "agreement_id": 987,
+ "agreement_id": 123,
"checkbox_text": "abc123",
- "content": "xyz789",
+ "content": "abc123",
"content_height": "abc123",
"is_html": false,
"mode": "AUTO",
- "name": "xyz789"
+ "name": "abc123"
}
@@ -30044,7 +30591,7 @@ Example
{
"code": "REORDER_NOT_AVAILABLE",
"message": "abc123",
- "path": ["xyz789"]
+ "path": ["abc123"]
}
@@ -30256,7 +30803,7 @@ Fields
Example
- {"uid": 4}
+ {"uid": "4"}
@@ -30441,7 +30988,7 @@ Fields
Example
{
"errors": [NegotiableQuoteInvalidStateError],
- "quote_uid": "4"
+ "quote_uid": 4
}
@@ -30667,7 +31214,7 @@ Fields
Example
{
"content": "xyz789",
- "identifier": "abc123",
+ "identifier": "xyz789",
"title": "xyz789"
}
@@ -30805,18 +31352,18 @@ Fields
Example
{
- "content": "xyz789",
+ "content": "abc123",
"content_heading": "abc123",
"identifier": "abc123",
- "meta_description": "xyz789",
+ "meta_description": "abc123",
"meta_keywords": "abc123",
- "meta_title": "abc123",
+ "meta_title": "xyz789",
"page_layout": "abc123",
- "redirect_code": 987,
- "relative_url": "xyz789",
+ "redirect_code": 123,
+ "relative_url": "abc123",
"title": "abc123",
"type": "CMS_PAGE",
- "url_key": "xyz789"
+ "url_key": "abc123"
}
@@ -31201,9 +31748,9 @@ Example
"email": "xyz789",
"id": 4,
"legal_address": CompanyLegalAddress,
- "legal_name": "xyz789",
- "name": "xyz789",
- "payment_methods": ["xyz789"],
+ "legal_name": "abc123",
+ "name": "abc123",
+ "payment_methods": ["abc123"],
"reseller_id": "abc123",
"role": CompanyRole,
"roles": CompanyRoles,
@@ -31212,7 +31759,7 @@ Example
"team": CompanyTeam,
"user": Customer,
"users": CompanyUsers,
- "vat_tax_id": "xyz789"
+ "vat_tax_id": "abc123"
}
@@ -31271,7 +31818,7 @@ Example
{
"children": [CompanyAclResource],
"id": "4",
- "sort_order": 123,
+ "sort_order": 987,
"text": "abc123"
}
@@ -31352,11 +31899,11 @@ Fields
Example
{
"custom_attributes": [AttributeValueInput],
- "email": "xyz789",
- "firstname": "abc123",
- "gender": 987,
+ "email": "abc123",
+ "firstname": "xyz789",
+ "gender": 123,
"job_title": "xyz789",
- "lastname": "abc123",
+ "lastname": "xyz789",
"telephone": "xyz789"
}
@@ -31401,6 +31948,11 @@ Fields
The name of the company.
+
+ status - CompanyStatusEnum
+
+ The current status of the company.
+
@@ -31410,8 +31962,9 @@ Fields
Example
{
"id": "4",
- "legal_name": "abc123",
- "name": "xyz789"
+ "legal_name": "xyz789",
+ "name": "xyz789",
+ "status": "PENDING"
}
@@ -31494,9 +32047,9 @@ Example
"company_email": "abc123",
"company_name": "xyz789",
"legal_address": CompanyLegalAddressCreateInput,
- "legal_name": "abc123",
+ "legal_name": "xyz789",
"reseller_id": "abc123",
- "vat_tax_id": "xyz789"
+ "vat_tax_id": "abc123"
}
@@ -31659,9 +32212,9 @@ Fields
Example
{
- "custom_reference_number": "abc123",
+ "custom_reference_number": "xyz789",
"operation_type": "ALLOCATION",
- "updated_by": "xyz789"
+ "updated_by": "abc123"
}
@@ -31952,7 +32505,7 @@ Fields
Example
{
"code": "abc123",
- "role_id": 4,
+ "role_id": "4",
"user": CompanyInvitationUserInput
}
@@ -32060,7 +32613,7 @@ Fields
Example
{
- "company_id": "4",
+ "company_id": 4,
"customer_id": 4,
"job_title": "xyz789",
"status": "ACTIVE",
@@ -32131,12 +32684,12 @@ Fields
Example
{
- "city": "xyz789",
+ "city": "abc123",
"country_code": "AF",
"postcode": "xyz789",
"region": CustomerAddressRegion,
- "street": ["abc123"],
- "telephone": "xyz789"
+ "street": ["xyz789"],
+ "telephone": "abc123"
}
@@ -32209,7 +32762,7 @@ Fields
Example
{
- "city": "xyz789",
+ "city": "abc123",
"country_id": "AF",
"postcode": "xyz789",
"region": CustomerAddressRegionInput,
@@ -32291,7 +32844,7 @@ Example
"country_id": "AF",
"postcode": "xyz789",
"region": CustomerAddressRegionInput,
- "street": ["xyz789"],
+ "street": ["abc123"],
"telephone": "abc123"
}
@@ -32350,7 +32903,7 @@ Fields
Example
{
"id": "4",
- "name": "abc123",
+ "name": "xyz789",
"permissions": [CompanyAclResource],
"users_count": 987
}
@@ -32401,8 +32954,8 @@ Fields
Example
{
- "name": "xyz789",
- "permissions": ["abc123"]
+ "name": "abc123",
+ "permissions": ["xyz789"]
}
@@ -32457,8 +33010,8 @@ Fields
Example
{
- "id": "4",
- "name": "abc123",
+ "id": 4,
+ "name": "xyz789",
"permissions": ["abc123"]
}
@@ -32566,9 +33119,68 @@ Fields
Example
{
"email": "xyz789",
- "firstname": "abc123",
+ "firstname": "xyz789",
"lastname": "xyz789"
}
+
+
+
+ back to top
+
+
rules - [CatalogRule]
+ sale - Int
currentPageExample
{
"activity": "xyz789",
- "attribute_set_id": 987,
- "canonical_url": "xyz789",
+ "attribute_set_id": 123,
+ "canonical_url": "abc123",
"categories": [CategoryInterface],
- "category_gear": "abc123",
- "climate": "xyz789",
- "collar": "xyz789",
+ "category_gear": "xyz789",
+ "climate": "abc123",
+ "collar": "abc123",
"color": 123,
"configurable_options": [ConfigurableProductOptions],
"configurable_product_options_selection": ConfigurableProductOptionsSelection,
@@ -34881,74 +34129,75 @@ Example
"custom_attributesV2": ProductCustomAttributes,
"description": ComplexTextValue,
"eco_collection": 987,
- "erin_recommends": 123,
+ "erin_recommends": 987,
"features_bags": "xyz789",
- "format": 123,
+ "format": 987,
"gender": "xyz789",
- "gift_message_available": true,
- "gift_wrapping_available": true,
+ "gift_message_available": false,
+ "gift_wrapping_available": false,
"gift_wrapping_price": Money,
"id": 123,
"image": ProductImage,
"is_returnable": "xyz789",
- "manufacturer": 987,
- "material": "xyz789",
- "max_sale_qty": 123.45,
+ "manufacturer": 123,
+ "material": "abc123",
+ "max_sale_qty": 987.65,
"media_gallery": [MediaGalleryInterface],
"media_gallery_entries": [MediaGalleryEntry],
"meta_description": "abc123",
- "meta_keyword": "abc123",
+ "meta_keyword": "xyz789",
"meta_title": "xyz789",
"min_sale_qty": 123.45,
- "name": "xyz789",
- "new": 123,
+ "name": "abc123",
+ "new": 987,
"new_from_date": "abc123",
"new_to_date": "abc123",
- "only_x_left_in_stock": 987.65,
+ "only_x_left_in_stock": 123.45,
"options": [CustomizableOptionInterface],
- "options_container": "xyz789",
+ "options_container": "abc123",
"pattern": "xyz789",
- "performance_fabric": 123,
+ "performance_fabric": 987,
"price": ProductPrices,
"price_range": PriceRange,
"price_tiers": [TierPrice],
"product_links": [ProductLinksInterface],
- "purpose": 987,
- "quantity": 123.45,
+ "purpose": 123,
+ "quantity": 987.65,
"rating_summary": 123.45,
- "redirect_code": 123,
+ "redirect_code": 987,
"related_products": [ProductInterface],
"relative_url": "xyz789",
- "review_count": 123,
+ "review_count": 987,
"reviews": ProductReviews,
- "sale": 123,
+ "rules": [CatalogRule],
+ "sale": 987,
"short_description": ComplexTextValue,
"size": 123,
"sku": "xyz789",
- "sleeve": "abc123",
+ "sleeve": "xyz789",
"small_image": ProductImage,
- "special_from_date": "xyz789",
- "special_price": 123.45,
+ "special_from_date": "abc123",
+ "special_price": 987.65,
"special_to_date": "xyz789",
"staged": true,
"stock_status": "IN_STOCK",
- "strap_bags": "xyz789",
- "style_bags": "abc123",
- "style_bottom": "xyz789",
- "style_general": "xyz789",
+ "strap_bags": "abc123",
+ "style_bags": "xyz789",
+ "style_bottom": "abc123",
+ "style_general": "abc123",
"swatch_image": "abc123",
"thumbnail": ProductImage,
"tier_price": 987.65,
"tier_prices": [ProductTierPrices],
"type": "CMS_PAGE",
"type_id": "xyz789",
- "uid": 4,
- "updated_at": "abc123",
+ "uid": "4",
+ "updated_at": "xyz789",
"upsell_products": [ProductInterface],
"url_key": "abc123",
- "url_path": "xyz789",
+ "url_path": "abc123",
"url_rewrites": [UrlRewrite],
- "url_suffix": "xyz789",
+ "url_suffix": "abc123",
"variants": [ConfigurableVariant],
"websites": [Website],
"weight": 987.65
@@ -35010,7 +34259,7 @@ Example
{
"customizable_options": [CustomizableOptionInput],
"data": CartItemInput,
- "parent_sku": "xyz789",
+ "parent_sku": "abc123",
"variant_sku": "abc123"
}
@@ -35068,8 +34317,8 @@ Fields
Example
{
"attribute_code": "abc123",
- "label": "xyz789",
- "uid": 4,
+ "label": "abc123",
+ "uid": "4",
"values": [ConfigurableProductOptionValue]
}
@@ -35133,9 +34382,9 @@ Example
{
"is_available": false,
"is_use_default": true,
- "label": "xyz789",
+ "label": "abc123",
"swatch": SwatchDataInterface,
- "uid": 4
+ "uid": "4"
}
@@ -35232,14 +34481,14 @@ Example
{
"attribute_code": "abc123",
"attribute_id": "xyz789",
- "attribute_id_v2": 123,
+ "attribute_id_v2": 987,
"attribute_uid": "4",
- "id": 123,
+ "id": 987,
"label": "abc123",
- "position": 987,
- "product_id": 123,
+ "position": 123,
+ "product_id": 987,
"uid": 4,
- "use_default": false,
+ "use_default": true,
"values": [ConfigurableProductOptionsValues]
}
@@ -35373,13 +34622,13 @@ Fields
Example
{
- "default_label": "abc123",
- "label": "xyz789",
+ "default_label": "xyz789",
+ "label": "abc123",
"store_label": "abc123",
"swatch_data": SwatchDataInterface,
"uid": "4",
- "use_default_value": true,
- "value_index": 123
+ "use_default_value": false,
+ "value_index": 987
}
@@ -35443,7 +34692,7 @@ Example
"configurable_options": [SelectedConfigurableOption],
"customizable_options": [SelectedCustomizableOption],
"product": ProductInterface,
- "quantity": 987.65,
+ "quantity": 123.45,
"uid": 4
}
@@ -35581,7 +34830,7 @@ Example
"description": "xyz789",
"id": "4",
"product": ProductInterface,
- "quantity": 987.65
+ "quantity": 123.45
}
@@ -35626,7 +34875,7 @@ Fields
Example
{
"confirmation_key": "xyz789",
- "order_id": "4"
+ "order_id": 4
}
@@ -35674,7 +34923,7 @@ Fields
Example
{
- "confirmation_key": "xyz789",
+ "confirmation_key": "abc123",
"email": "xyz789"
}
@@ -35719,8 +34968,8 @@ Fields
Example
{
- "confirmation_key": "abc123",
- "order_id": 4
+ "confirmation_key": "xyz789",
+ "order_id": "4"
}
@@ -35822,10 +35071,10 @@ Fields
Example
{
- "comment": "xyz789",
+ "comment": "abc123",
"email": "abc123",
- "name": "xyz789",
- "telephone": "abc123"
+ "name": "abc123",
+ "telephone": "xyz789"
}
@@ -35865,7 +35114,7 @@ Fields
Example
- {"status": true}
+ {"status": false}
@@ -35905,7 +35154,7 @@ Fields
Example
- {"requisitionListItemUids": ["4"]}
+ {"requisitionListItemUids": [4]}
@@ -36059,10 +35308,10 @@ Fields
Example
{
"available_regions": [Region],
- "full_name_english": "xyz789",
- "full_name_locale": "abc123",
+ "full_name_english": "abc123",
+ "full_name_locale": "xyz789",
"id": "xyz789",
- "three_letter_abbreviation": "xyz789",
+ "three_letter_abbreviation": "abc123",
"two_letter_abbreviation": "abc123"
}
@@ -37851,7 +37100,7 @@ Example
GiftRegistryDynamicAttributeInput
],
"event_name": "xyz789",
- "gift_registry_type_uid": 4,
+ "gift_registry_type_uid": "4",
"message": "abc123",
"privacy_settings": "PRIVATE",
"registrants": [AddGiftRegistryRegistrantInput],
@@ -37932,7 +37181,7 @@ Fields
Example
- {"cart_uid": 4}
+ {"cart_uid": "4"}
@@ -38028,8 +37277,8 @@ Fields
Example
{
"response_message": "xyz789",
- "result": 123,
- "result_code": 987,
+ "result": 987,
+ "result_code": 123,
"secure_token": "xyz789",
"secure_token_id": "xyz789"
}
@@ -38099,7 +37348,7 @@ Example
{
"cartId": "xyz789",
"location": "PRODUCT_DETAIL",
- "methodCode": "abc123",
+ "methodCode": "xyz789",
"paymentSource": "abc123",
"vaultIntent": false
}
@@ -38162,11 +37411,11 @@ Fields
Example
{
- "amount": 123.45,
+ "amount": 987.65,
"currency_code": "xyz789",
"id": "xyz789",
"mp_order_id": "xyz789",
- "status": "abc123"
+ "status": "xyz789"
}
@@ -38232,10 +37481,10 @@ Fields
Example
{
- "nickname": "abc123",
+ "nickname": "xyz789",
"ratings": [ProductReviewRatingInput],
- "sku": "xyz789",
- "summary": "xyz789",
+ "sku": "abc123",
+ "summary": "abc123",
"text": "xyz789"
}
@@ -38322,7 +37571,7 @@ Fields
Example
- {"currency": "AFN", "value": 987.65}
+ {"currency": "AFN", "value": 123.45}
@@ -38432,8 +37681,8 @@ Fields
Example
{
- "description": "abc123",
- "name": "abc123"
+ "description": "xyz789",
+ "name": "xyz789"
}
@@ -38521,7 +37770,7 @@ Fields
Example
{
"card_description": "xyz789",
- "setup_token_id": "abc123"
+ "setup_token_id": "xyz789"
}
@@ -38657,7 +37906,7 @@ Fields
Example
- {"setup_token": "abc123"}
+ {"setup_token": "xyz789"}
@@ -38803,8 +38052,8 @@ Example
{
"cc_exp_month": 987,
"cc_exp_year": 123,
- "cc_last_4": 123,
- "cc_type": "abc123"
+ "cc_last_4": 987,
+ "cc_type": "xyz789"
}
@@ -38939,7 +38188,7 @@ Example
"discounts": [Discount],
"id": "4",
"order_item": OrderItemInterface,
- "product_name": "xyz789",
+ "product_name": "abc123",
"product_sale_price": Money,
"product_sku": "abc123",
"quantity_refunded": 987.65
@@ -39019,12 +38268,12 @@ Possible Types
-
+
-
+
@@ -39051,7 +38300,7 @@ Example
"product_name": "xyz789",
"product_sale_price": Money,
"product_sku": "xyz789",
- "quantity_refunded": 123.45
+ "quantity_refunded": 987.65
}
@@ -39217,11 +38466,11 @@ Fields
Example
{
"available_currency_codes": ["xyz789"],
- "base_currency_code": "xyz789",
+ "base_currency_code": "abc123",
"base_currency_symbol": "xyz789",
"default_display_currecy_code": "xyz789",
- "default_display_currecy_symbol": "xyz789",
- "default_display_currency_code": "xyz789",
+ "default_display_currecy_symbol": "abc123",
+ "default_display_currency_code": "abc123",
"default_display_currency_symbol": "xyz789",
"exchange_rates": [ExchangeRate]
}
@@ -40600,12 +39849,12 @@ Possible Types
Example
{
"code": 4,
- "default_value": "abc123",
+ "default_value": "xyz789",
"entity_type": "CATALOG_PRODUCT",
"frontend_class": "abc123",
"frontend_input": "BOOLEAN",
"is_required": true,
- "is_unique": true,
+ "is_unique": false,
"label": "xyz789",
"options": [CustomAttributeOptionInterface]
}
@@ -40671,7 +39920,7 @@ Possible Types
Example
{
- "is_default": false,
+ "is_default": true,
"label": "xyz789",
"value": "abc123"
}
@@ -40846,9 +40095,9 @@ giftRegistryUi
- group - CustomerGroupStorefront
+ group - CustomerGroup
- Customer group assigned to the customer
+ Name of the customer group assigned to the customer
group_id - Int
@@ -40858,9 +40107,10 @@ giftRegistryUi
- id - ID!
+ id - Int
+
+ The ID assigned to the customer. id is not needed as part of Customer, because on the server side, it can be identified based on the customer token used for authentication. There is no need to know customer ID on the client side.
- The unique ID assigned to the customer.
is_subscribed - Boolean
@@ -41127,7 +40377,7 @@ currentPage The role name and permissions assigned to the company user.
- segments - [CustomerSegmentStorefront]
+ segments - [CustomerSegment]
Customer segments associated with the current customer
@@ -41228,24 +40478,24 @@ Example
"companies": UserCompaniesOutput,
"compare_list": CompareList,
"confirmation_status": "ACCOUNT_CONFIRMED",
- "created_at": "abc123",
+ "created_at": "xyz789",
"custom_attributes": [AttributeValueInterface],
"date_of_birth": "xyz789",
"default_billing": "xyz789",
"default_shipping": "abc123",
- "dob": "xyz789",
- "email": "abc123",
+ "dob": "abc123",
+ "email": "xyz789",
"firstname": "abc123",
"gender": 123,
"gift_registries": [GiftRegistry],
"gift_registry": GiftRegistry,
- "group": CustomerGroupStorefront,
+ "group": CustomerGroup,
"group_id": 123,
- "id": "4",
- "is_subscribed": false,
- "job_title": "abc123",
- "lastname": "abc123",
- "middlename": "xyz789",
+ "id": 123,
+ "is_subscribed": true,
+ "job_title": "xyz789",
+ "lastname": "xyz789",
+ "middlename": "abc123",
"orders": CustomerOrders,
"prefix": "xyz789",
"purchase_order": PurchaseOrder,
@@ -41253,21 +40503,21 @@ Example
"purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata,
"purchase_order_approval_rules": PurchaseOrderApprovalRules,
"purchase_orders": PurchaseOrders,
- "purchase_orders_enabled": false,
+ "purchase_orders_enabled": true,
"requisition_lists": RequisitionLists,
"return": Return,
"returns": Returns,
"reviews": ProductReviews,
"reward_points": RewardPoints,
"role": CompanyRole,
- "segments": [CustomerSegmentStorefront],
+ "segments": [CustomerSegment],
"status": "ACTIVE",
"store_credit": CustomerStoreCredit,
- "structure_id": 4,
- "suffix": "abc123",
+ "structure_id": "4",
+ "suffix": "xyz789",
"taxvat": "xyz789",
"team": CompanyTeam,
- "telephone": "xyz789",
+ "telephone": "abc123",
"wishlist": Wishlist,
"wishlist_v2": Wishlist,
"wishlists": [Wishlist]
@@ -41376,10 +40626,9 @@ attributeCodes
The first name of the person associated with the shipping/billing address.
- id - Int
-
- The ID of a CustomerAddress object. Use uid instead.
+ id - Int
+ The ID of a CustomerAddress object.
lastname - String
@@ -41426,11 +40675,6 @@ attributeCodes
The customer's telephone number.
-
- uid - ID
-
- The unique ID for a CustomerAddress object.
-
vat_id - String
@@ -41444,29 +40688,28 @@ attributeCodes
Example
{
- "city": "xyz789",
+ "city": "abc123",
"company": "xyz789",
"country_code": "AF",
- "country_id": "abc123",
+ "country_id": "xyz789",
"custom_attributes": [CustomerAddressAttribute],
"custom_attributesV2": [AttributeValueInterface],
"customer_id": 987,
- "default_billing": true,
- "default_shipping": true,
+ "default_billing": false,
+ "default_shipping": false,
"extension_attributes": [CustomerAddressAttribute],
"fax": "xyz789",
"firstname": "abc123",
"id": 987,
- "lastname": "xyz789",
+ "lastname": "abc123",
"middlename": "abc123",
"postcode": "abc123",
- "prefix": "abc123",
+ "prefix": "xyz789",
"region": CustomerAddressRegion,
- "region_id": 987,
+ "region_id": 123,
"street": ["xyz789"],
"suffix": "xyz789",
- "telephone": "abc123",
- "uid": 4,
+ "telephone": "xyz789",
"vat_id": "xyz789"
}
@@ -41514,7 +40757,7 @@ Fields
Example
{
"attribute_code": "abc123",
- "value": "abc123"
+ "value": "xyz789"
}
@@ -41563,7 +40806,7 @@ Fields
Example
{
"attribute_code": "xyz789",
- "value": "abc123"
+ "value": "xyz789"
}
@@ -41715,24 +40958,24 @@ Fields
Example
{
- "city": "abc123",
+ "city": "xyz789",
"company": "abc123",
"country_code": "AF",
"country_id": "AF",
"custom_attributes": [CustomerAddressAttributeInput],
"custom_attributesV2": [AttributeValueInput],
- "default_billing": false,
+ "default_billing": true,
"default_shipping": false,
"fax": "xyz789",
- "firstname": "xyz789",
- "lastname": "abc123",
- "middlename": "abc123",
+ "firstname": "abc123",
+ "lastname": "xyz789",
+ "middlename": "xyz789",
"postcode": "xyz789",
"prefix": "xyz789",
"region": CustomerAddressRegionInput,
"street": ["xyz789"],
- "suffix": "xyz789",
- "telephone": "abc123",
+ "suffix": "abc123",
+ "telephone": "xyz789",
"vat_id": "xyz789"
}
@@ -41785,7 +41028,7 @@ Fields
Example
{
"region": "abc123",
- "region_code": "abc123",
+ "region_code": "xyz789",
"region_id": 987
}
@@ -41840,9 +41083,9 @@ Fields
Example
{
- "region": "abc123",
- "region_code": "abc123",
- "region_id": 987
+ "region": "xyz789",
+ "region_code": "xyz789",
+ "region_id": 123
}
@@ -41995,13 +41238,13 @@ Example
"code": "4",
"default_value": "xyz789",
"entity_type": "CATALOG_PRODUCT",
- "frontend_class": "xyz789",
+ "frontend_class": "abc123",
"frontend_input": "BOOLEAN",
"input_filter": "NONE",
"is_required": true,
- "is_unique": true,
+ "is_unique": false,
"label": "abc123",
- "multiline_count": 123,
+ "multiline_count": 987,
"options": [CustomAttributeOptionInterface],
"sort_order": 987,
"validate_rules": [ValidationRule]
@@ -42129,16 +41372,16 @@ Example
"custom_attributes": [AttributeValueInput],
"date_of_birth": "xyz789",
"dob": "abc123",
- "email": "xyz789",
+ "email": "abc123",
"firstname": "abc123",
"gender": 987,
- "is_subscribed": false,
- "lastname": "xyz789",
+ "is_subscribed": true,
+ "lastname": "abc123",
"middlename": "xyz789",
"password": "abc123",
"prefix": "abc123",
"suffix": "abc123",
- "taxvat": "abc123"
+ "taxvat": "xyz789"
}
@@ -42202,8 +41445,8 @@ Example
"date": "abc123",
"download_url": "xyz789",
"order_increment_id": "abc123",
- "remaining_downloads": "abc123",
- "status": "abc123"
+ "remaining_downloads": "xyz789",
+ "status": "xyz789"
}
@@ -42249,11 +41492,11 @@ Example
-
+
- CustomerGroupStorefront
+ CustomerGroup
@@ -42271,9 +41514,9 @@ Fields
- uid - ID!
+ name - String
- The unique ID for a CustomerGroup object.
+ The name of customer group.
@@ -42282,7 +41525,7 @@ Fields
Example
- {"uid": 4}
+ {"name": "xyz789"}
@@ -42391,17 +41634,17 @@ Fields
Example
{
"date_of_birth": "xyz789",
- "dob": "abc123",
- "email": "abc123",
- "firstname": "abc123",
+ "dob": "xyz789",
+ "email": "xyz789",
+ "firstname": "xyz789",
"gender": 987,
- "is_subscribed": true,
- "lastname": "xyz789",
+ "is_subscribed": false,
+ "lastname": "abc123",
"middlename": "xyz789",
"password": "abc123",
- "prefix": "abc123",
- "suffix": "xyz789",
- "taxvat": "abc123"
+ "prefix": "xyz789",
+ "suffix": "abc123",
+ "taxvat": "xyz789"
}
@@ -42635,34 +41878,34 @@ Example
"applied_gift_cards": [ApplyGiftCardToOrder],
"available_actions": ["REORDER"],
"billing_address": OrderAddress,
- "carrier": "xyz789",
+ "carrier": "abc123",
"comments": [SalesCommentItem],
"created_at": "xyz789",
"credit_memos": [CreditMemo],
"customer_info": OrderCustomerInfo,
- "email": "xyz789",
+ "email": "abc123",
"gift_message": GiftMessage,
- "gift_receipt_included": false,
+ "gift_receipt_included": true,
"gift_wrapping": GiftWrapping,
- "grand_total": 123.45,
+ "grand_total": 987.65,
"id": 4,
"increment_id": "xyz789",
"invoices": [Invoice],
"is_virtual": false,
"items": [OrderItemInterface],
"items_eligible_for_return": [OrderItemInterface],
- "number": "abc123",
- "order_date": "abc123",
- "order_number": "abc123",
+ "number": "xyz789",
+ "order_date": "xyz789",
+ "order_number": "xyz789",
"order_status_change_date": "xyz789",
"payment_methods": [OrderPaymentMethod],
- "printed_card_included": true,
+ "printed_card_included": false,
"returns": Returns,
"shipments": [OrderShipment],
"shipping_address": OrderAddress,
"shipping_method": "abc123",
- "status": "abc123",
- "token": "abc123",
+ "status": "xyz789",
+ "token": "xyz789",
"total": OrderTotal
}
@@ -42962,16 +42205,16 @@ Example
-
+
- CustomerSegmentStorefront
+ CustomerSegment
Description
- Customer segment details
+ Customer segment.
Fields
@@ -42984,9 +42227,19 @@ Fields
- uid - ID!
+ apply_to - CustomerSegmentApplyTo!
+
+ Customer segment is applicable to visitor, registered customer or both.
+
+
+ description - String
+
+ Customer segment description.
+
+
+ name - String!
- The unique ID for a CustomerSegment object.
+ Customer segment name.
@@ -42995,7 +42248,63 @@ Fields
Example
- {"uid": 4}
+ {
+ "apply_to": "BOTH",
+ "description": "xyz789",
+ "name": "abc123"
+}
+
+
+
+
+
+
+
+ Types
+
+ CustomerSegmentApplyTo
+
+
+
+ Description
+ Customer segment is applicable to visitor, registered customers or both.
+
+
+ Values
+
+
+
+ Enum Value
+ Description
+
+
+
+
+
+ BOTH
+
+ Customer segment is applicable to visitor and registered customers.
+
+
+
+ REGISTERED
+
+ Customer segment is applicable to registered customers.
+
+
+
+ VISITOR
+
+ Customer segment is applicable to visitors/guests.
+
+
+
+
+
+
+
+ Example
+ "BOTH"
@@ -43175,10 +42484,10 @@ Fields
Example
{
- "action": "xyz789",
+ "action": "abc123",
"actual_balance": Money,
"balance_change": Money,
- "date_time_changed": "abc123"
+ "date_time_changed": "xyz789"
}
@@ -43218,7 +42527,7 @@ Fields
Example
- {"token": "abc123"}
+ {"token": "xyz789"}
@@ -43326,18 +42635,18 @@ Fields
Example
{
- "allow_remote_shopping_assistance": false,
+ "allow_remote_shopping_assistance": true,
"custom_attributes": [AttributeValueInput],
- "date_of_birth": "abc123",
- "dob": "abc123",
+ "date_of_birth": "xyz789",
+ "dob": "xyz789",
"firstname": "xyz789",
- "gender": 123,
- "is_subscribed": false,
- "lastname": "abc123",
+ "gender": 987,
+ "is_subscribed": true,
+ "lastname": "xyz789",
"middlename": "xyz789",
- "prefix": "xyz789",
+ "prefix": "abc123",
"suffix": "xyz789",
- "taxvat": "abc123"
+ "taxvat": "xyz789"
}
@@ -43409,12 +42718,12 @@ Fields
Example
{
- "option_id": 123,
+ "option_id": 987,
"product_sku": "abc123",
- "required": true,
- "sort_order": 123,
- "title": "xyz789",
- "uid": "4",
+ "required": false,
+ "sort_order": 987,
+ "title": "abc123",
+ "uid": 4,
"value": CustomizableAreaValue
}
@@ -43476,11 +42785,11 @@ Fields
Example
{
- "max_characters": 987,
- "price": 123.45,
+ "max_characters": 123,
+ "price": 987.65,
"price_type": "FIXED",
"sku": "abc123",
- "uid": "4"
+ "uid": 4
}
@@ -43549,8 +42858,8 @@ Example
{
"option_id": 123,
"required": true,
- "sort_order": 123,
- "title": "abc123",
+ "sort_order": 987,
+ "title": "xyz789",
"uid": "4",
"value": [CustomizableCheckboxValue]
}
@@ -43624,12 +42933,12 @@ Fields
Example
{
"option_type_id": 123,
- "price": 123.45,
+ "price": 987.65,
"price_type": "FIXED",
- "sku": "xyz789",
- "sort_order": 123,
+ "sku": "abc123",
+ "sort_order": 987,
"title": "abc123",
- "uid": "4"
+ "uid": 4
}
@@ -43701,12 +43010,12 @@ Fields
Example
{
- "option_id": 987,
+ "option_id": 123,
"product_sku": "xyz789",
"required": true,
- "sort_order": 123,
+ "sort_order": 987,
"title": "xyz789",
- "uid": "4",
+ "uid": 4,
"value": CustomizableDateValue
}
@@ -43897,7 +43206,7 @@ Example
"option_id": 987,
"required": false,
"sort_order": 123,
- "title": "xyz789",
+ "title": "abc123",
"uid": 4,
"value": [CustomizableDropDownValue]
}
@@ -43971,11 +43280,11 @@ Fields
Example
{
"option_type_id": 987,
- "price": 123.45,
+ "price": 987.65,
"price_type": "FIXED",
"sku": "xyz789",
- "sort_order": 987,
- "title": "abc123",
+ "sort_order": 123,
+ "title": "xyz789",
"uid": 4
}
@@ -44050,10 +43359,10 @@ Example
{
"option_id": 987,
"product_sku": "abc123",
- "required": false,
+ "required": true,
"sort_order": 123,
"title": "xyz789",
- "uid": 4,
+ "uid": "4",
"value": CustomizableFieldValue
}
@@ -44118,7 +43427,7 @@ Example
"max_characters": 987,
"price": 123.45,
"price_type": "FIXED",
- "sku": "abc123",
+ "sku": "xyz789",
"uid": "4"
}
@@ -44193,9 +43502,9 @@ Example
{
"option_id": 987,
"product_sku": "xyz789",
- "required": true,
+ "required": false,
"sort_order": 123,
- "title": "abc123",
+ "title": "xyz789",
"uid": 4,
"value": CustomizableFileValue
}
@@ -44270,10 +43579,10 @@ Example
{
"file_extension": "xyz789",
"image_size_x": 987,
- "image_size_y": 987,
+ "image_size_y": 123,
"price": 123.45,
"price_type": "FIXED",
- "sku": "abc123",
+ "sku": "xyz789",
"uid": 4
}
@@ -44341,11 +43650,11 @@ Fields
Example
{
- "option_id": 123,
- "required": false,
- "sort_order": 987,
+ "option_id": 987,
+ "required": true,
+ "sort_order": 123,
"title": "xyz789",
- "uid": "4",
+ "uid": 4,
"value": [CustomizableMultipleValue]
}
@@ -44418,12 +43727,12 @@ Fields
Example
{
"option_type_id": 123,
- "price": 123.45,
+ "price": 987.65,
"price_type": "FIXED",
- "sku": "abc123",
+ "sku": "xyz789",
"sort_order": 987,
"title": "abc123",
- "uid": "4"
+ "uid": 4
}
@@ -44479,7 +43788,7 @@ Example
{
"id": 123,
"uid": 4,
- "value_string": "abc123"
+ "value_string": "xyz789"
}
@@ -44595,9 +43904,9 @@ Example
{
"option_id": 123,
"required": true,
- "sort_order": 123,
+ "sort_order": 987,
"title": "abc123",
- "uid": "4"
+ "uid": 4
}
@@ -44659,12 +43968,12 @@ Possible Types
-
+
-
+
@@ -44747,7 +44056,7 @@ Example
{
"option_id": 987,
"required": false,
- "sort_order": 987,
+ "sort_order": 123,
"title": "xyz789",
"uid": 4,
"value": [CustomizableRadioValue]
@@ -44822,10 +44131,10 @@ Fields
Example
{
"option_type_id": 123,
- "price": 987.65,
+ "price": 123.45,
"price_type": "FIXED",
- "sku": "abc123",
- "sort_order": 987,
+ "sku": "xyz789",
+ "sort_order": 123,
"title": "abc123",
"uid": "4"
}
@@ -44906,7 +44215,7 @@ Fields
Example
- {"success": true}
+ {"success": false}
@@ -45075,7 +44384,7 @@ Fields
Example
{
"errors": [NegotiableQuoteInvalidStateError],
- "quote_uid": 4
+ "quote_uid": "4"
}
@@ -45155,7 +44464,7 @@ Fields
Example
- {"template_id": 4}
+ {"template_id": "4"}
@@ -45191,7 +44500,7 @@ Fields
Example
- {"quote_uids": ["4"]}
+ {"quote_uids": [4]}
@@ -45321,7 +44630,7 @@ Fields
Example
{
"customerPaymentTokens": CustomerPaymentTokens,
- "result": true
+ "result": false
}
@@ -45450,7 +44759,7 @@ Fields
Example
- {"approval_rule_uids": [4]}
+ {"approval_rule_uids": ["4"]}
@@ -45616,7 +44925,7 @@ Fields
Example
- {"status": true, "wishlists": [Wishlist]}
+ {"status": false, "wishlists": [Wishlist]}
@@ -45689,10 +44998,10 @@ Example
"amount": Money,
"applied_to": "ITEM",
"coupon": AppliedCoupon,
- "is_discounting_locked": false,
+ "is_discounting_locked": true,
"label": "abc123",
- "type": "xyz789",
- "value": 987.65
+ "type": "abc123",
+ "value": 123.45
}
@@ -45813,7 +45122,7 @@ Example
"customizable_options": [SelectedCustomizableOption],
"discount": [Discount],
"errors": [CartItemError],
- "id": "xyz789",
+ "id": "abc123",
"is_available": false,
"links": [DownloadableProductLinks],
"max_qty": 987.65,
@@ -45823,9 +45132,9 @@ Example
"note_from_seller": [ItemNote],
"prices": CartItemPrices,
"product": ProductInterface,
- "quantity": 123.45,
+ "quantity": 987.65,
"samples": [DownloadableProductSamples],
- "uid": "4"
+ "uid": 4
}
@@ -45903,12 +45212,12 @@ Example
{
"discounts": [Discount],
"downloadable_links": [DownloadableItemsLinks],
- "id": "4",
+ "id": 4,
"order_item": OrderItemInterface,
- "product_name": "xyz789",
+ "product_name": "abc123",
"product_sale_price": Money,
- "product_sku": "xyz789",
- "quantity_refunded": 987.65
+ "product_sku": "abc123",
+ "quantity_refunded": 123.45
}
@@ -46032,12 +45341,12 @@ Example
{
"discounts": [Discount],
"downloadable_links": [DownloadableItemsLinks],
- "id": 4,
+ "id": "4",
"order_item": OrderItemInterface,
- "product_name": "abc123",
+ "product_name": "xyz789",
"product_sale_price": Money,
- "product_sku": "abc123",
- "quantity_invoiced": 987.65
+ "product_sku": "xyz789",
+ "quantity_invoiced": 123.45
}
@@ -46090,7 +45399,7 @@ Example
{
"sort_order": 987,
"title": "xyz789",
- "uid": 4
+ "uid": "4"
}
@@ -46243,7 +45552,7 @@ Example
{
"discounts": [Discount],
"downloadable_links": [DownloadableItemsLinks],
- "eligible_for_return": true,
+ "eligible_for_return": false,
"entered_options": [OrderItemOption],
"gift_message": GiftMessage,
"gift_wrapping": GiftWrapping,
@@ -46252,18 +45561,18 @@ Example
"product": ProductInterface,
"product_name": "xyz789",
"product_sale_price": Money,
- "product_sku": "xyz789",
- "product_type": "abc123",
+ "product_sku": "abc123",
+ "product_type": "xyz789",
"product_url_key": "xyz789",
- "quantity_canceled": 123.45,
+ "quantity_canceled": 987.65,
"quantity_invoiced": 123.45,
- "quantity_ordered": 123.45,
- "quantity_refunded": 123.45,
- "quantity_return_requested": 123.45,
+ "quantity_ordered": 987.65,
+ "quantity_refunded": 987.65,
+ "quantity_return_requested": 987.65,
"quantity_returned": 987.65,
"quantity_shipped": 987.65,
"selected_options": [OrderItemOption],
- "status": "abc123"
+ "status": "xyz789"
}
@@ -46649,6 +45958,11 @@ currentPage
+
+ rules - [CatalogRule]
+
+ Provides applied catalog rules in the current active cart
+
sale - Int
@@ -46824,15 +46138,15 @@ currentPage
Example
{
- "activity": "abc123",
+ "activity": "xyz789",
"attribute_set_id": 987,
"canonical_url": "xyz789",
"categories": [CategoryInterface],
- "category_gear": "xyz789",
+ "category_gear": "abc123",
"climate": "abc123",
- "collar": "xyz789",
- "color": 123,
- "country_of_manufacture": "xyz789",
+ "collar": "abc123",
+ "color": 987,
+ "country_of_manufacture": "abc123",
"created_at": "abc123",
"crosssell_products": [ProductInterface],
"custom_attributesV2": ProductCustomAttributes,
@@ -46843,77 +46157,78 @@ Example
"downloadable_product_samples": [
DownloadableProductSamples
],
- "eco_collection": 123,
- "erin_recommends": 123,
- "features_bags": "xyz789",
- "format": 987,
- "gender": "xyz789",
+ "eco_collection": 987,
+ "erin_recommends": 987,
+ "features_bags": "abc123",
+ "format": 123,
+ "gender": "abc123",
"gift_message_available": true,
- "gift_wrapping_available": true,
+ "gift_wrapping_available": false,
"gift_wrapping_price": Money,
- "id": 987,
+ "id": 123,
"image": ProductImage,
"is_returnable": "xyz789",
"links_purchased_separately": 123,
"links_title": "abc123",
- "manufacturer": 987,
+ "manufacturer": 123,
"material": "abc123",
"max_sale_qty": 987.65,
"media_gallery": [MediaGalleryInterface],
"media_gallery_entries": [MediaGalleryEntry],
- "meta_description": "xyz789",
- "meta_keyword": "xyz789",
+ "meta_description": "abc123",
+ "meta_keyword": "abc123",
"meta_title": "abc123",
- "min_sale_qty": 123.45,
- "name": "xyz789",
- "new": 123,
- "new_from_date": "abc123",
+ "min_sale_qty": 987.65,
+ "name": "abc123",
+ "new": 987,
+ "new_from_date": "xyz789",
"new_to_date": "abc123",
"only_x_left_in_stock": 987.65,
"options": [CustomizableOptionInterface],
"options_container": "xyz789",
- "pattern": "xyz789",
+ "pattern": "abc123",
"performance_fabric": 987,
"price": ProductPrices,
"price_range": PriceRange,
"price_tiers": [TierPrice],
"product_links": [ProductLinksInterface],
- "purpose": 987,
+ "purpose": 123,
"quantity": 987.65,
- "rating_summary": 987.65,
+ "rating_summary": 123.45,
"redirect_code": 123,
"related_products": [ProductInterface],
"relative_url": "xyz789",
"review_count": 987,
"reviews": ProductReviews,
- "sale": 987,
+ "rules": [CatalogRule],
+ "sale": 123,
"short_description": ComplexTextValue,
- "size": 987,
- "sku": "abc123",
- "sleeve": "abc123",
+ "size": 123,
+ "sku": "xyz789",
+ "sleeve": "xyz789",
"small_image": ProductImage,
"special_from_date": "abc123",
"special_price": 123.45,
"special_to_date": "xyz789",
- "staged": false,
+ "staged": true,
"stock_status": "IN_STOCK",
"strap_bags": "abc123",
"style_bags": "xyz789",
- "style_bottom": "abc123",
+ "style_bottom": "xyz789",
"style_general": "abc123",
"swatch_image": "abc123",
"thumbnail": ProductImage,
- "tier_price": 123.45,
+ "tier_price": 987.65,
"tier_prices": [ProductTierPrices],
"type": "CMS_PAGE",
- "type_id": "abc123",
- "uid": "4",
- "updated_at": "xyz789",
+ "type_id": "xyz789",
+ "uid": 4,
+ "updated_at": "abc123",
"upsell_products": [ProductInterface],
"url_key": "xyz789",
- "url_path": "abc123",
+ "url_path": "xyz789",
"url_rewrites": [UrlRewrite],
- "url_suffix": "abc123",
+ "url_suffix": "xyz789",
"websites": [Website]
}
@@ -47075,17 +46390,17 @@ Fields
Example
{
- "id": 123,
- "is_shareable": true,
+ "id": 987,
+ "is_shareable": false,
"link_type": "FILE",
"number_of_downloads": 123,
- "price": 987.65,
- "sample_file": "abc123",
+ "price": 123.45,
+ "sample_file": "xyz789",
"sample_type": "FILE",
- "sample_url": "abc123",
+ "sample_url": "xyz789",
"sort_order": 123,
"title": "xyz789",
- "uid": 4
+ "uid": "4"
}
@@ -47126,7 +46441,7 @@ Fields
Example
- {"link_id": 987}
+ {"link_id": 123}
@@ -47197,12 +46512,12 @@ Fields
Example
{
- "id": 123,
- "sample_file": "abc123",
+ "id": 987,
+ "sample_file": "xyz789",
"sample_type": "FILE",
"sample_url": "abc123",
- "sort_order": 987,
- "title": "abc123"
+ "sort_order": 123,
+ "title": "xyz789"
}
@@ -47273,7 +46588,7 @@ Example
"product": ProductInterface,
"quantity": 987.65,
"samples": [DownloadableProductSamples],
- "uid": 4
+ "uid": "4"
}
@@ -47349,7 +46664,7 @@ Fields
Example
{
- "added_at": "xyz789",
+ "added_at": "abc123",
"customizable_options": [SelectedCustomizableOption],
"description": "xyz789",
"id": "4",
@@ -47404,8 +46719,8 @@ Fields
Example
{
- "duplicated_quote_uid": "4",
- "quote_uid": 4
+ "duplicated_quote_uid": 4,
+ "quote_uid": "4"
}
@@ -47665,7 +46980,7 @@ Example
{
"items": [DynamicBlock],
"page_info": SearchResultPageInfo,
- "total_count": 123
+ "total_count": 987
}
@@ -47718,11 +47033,7 @@ Fields
Example
- {
- "dynamic_block_uids": ["4"],
- "locations": ["CONTENT"],
- "type": "SPECIFIED"
-}
+ {"dynamic_block_uids": [4], "locations": ["CONTENT"], "type": "SPECIFIED"}
@@ -47769,8 +47080,8 @@ Fields
Example
{
- "attribute_code": "xyz789",
- "value": "xyz789"
+ "attribute_code": "abc123",
+ "value": "abc123"
}
@@ -47817,7 +47128,10 @@ Fields
Example
- {"uid": 4, "value": "abc123"}
+ {
+ "uid": "4",
+ "value": "xyz789"
+}
@@ -47885,9 +47199,9 @@ Fields
Example
{
- "canonical_url": "xyz789",
- "entity_uid": 4,
- "id": 123,
+ "canonical_url": "abc123",
+ "entity_uid": "4",
+ "id": 987,
"redirectCode": 123,
"relative_url": "xyz789",
"type": "CMS_PAGE"
@@ -47959,7 +47273,7 @@ Possible Types
Example
{
"code": "PRODUCT_NOT_FOUND",
- "message": "abc123"
+ "message": "xyz789"
}
@@ -48022,7 +47336,7 @@ Possible Types
Example
- {"message": "xyz789"}
+ {"message": "abc123"}
@@ -48076,7 +47390,7 @@ Fields
Example
{
"country_code": "AF",
- "postcode": "xyz789",
+ "postcode": "abc123",
"region": CustomerAddressRegionInput
}
@@ -48128,7 +47442,7 @@ Fields
Example
{
"address": EstimateAddressInput,
- "cart_id": "abc123",
+ "cart_id": "xyz789",
"shipping_method": ShippingMethodInput
}
@@ -48170,93 +47484,6 @@ Fields
Example
{"cart": Cart}
-
-
-
-
-
-
-
- Types
-
- ExchangeExternalCustomerTokenInput
-
-
-
- Description
- Contains details about external customer.
-
-
- Fields
-
-
-
- Input Field
- Description
-
-
-
-
-
- customer - CustomerCreateInput!
-
- An input object that defines the customer characteristics to update.
-
-
-
-
-
-
-
- Example
- {"customer": CustomerCreateInput}
-
-
-
-
-
-
-
- Types
-
- ExchangeExternalCustomerTokenOutput
-
-
-
- Description
- Contains customer token for external customer.
-
-
-
-
-
- Example
- {
- "customer": Customer,
- "token": "xyz789"
-}
@@ -48300,135 +47527,7 @@ Fields
Example
- {"currency_to": "xyz789", "rate": 987.65}
-
-
-
-
-
-
-
- Types
-
- FastlaneConfig
-
-
-
- Fields
-
-
-
- Field Name
- Description
-
-
-
-
- code - String
-
- The payment method code as defined in the payment gateway
-
-
- is_visible - Boolean
-
- Indicates whether the payment method is displayed
-
-
- payment_intent - String
-
- Defines the payment intent (Authorize or Capture
-
-
- payment_source - String
-
- The payment source for the payment method
-
-
- sdk_params - [SDKParams]
-
- The PayPal parameters required to load the JS SDK
-
-
- sort_order - String
-
- The relative order the payment method is displayed on the checkout page
-
-
- three_ds_mode - ThreeDSMode
-
- 3DS mode
-
-
- title - String
-
- The name displayed for the payment method
-
-
-
-
-
-
-
- Example
- {
- "code": "xyz789",
- "is_visible": false,
- "payment_intent": "abc123",
- "payment_source": "abc123",
- "sdk_params": [SDKParams],
- "sort_order": "abc123",
- "three_ds_mode": "OFF",
- "title": "xyz789"
-}
-
-
-
-
-
-
-
- Types
-
- FastlaneMethodInput
-
-
-
- Description
- Fastlane Payment inputs
-
-
-
-
-
- Example
- {
- "payment_source": "abc123",
- "paypal_fastlane_token": "abc123"
-}
+ {"currency_to": "abc123", "rate": 123.45}
@@ -48475,7 +47574,7 @@ Fields
Example
{
- "eq": "abc123",
+ "eq": "xyz789",
"in": ["xyz789"]
}
@@ -48567,7 +47666,7 @@ Fields
Example
- {"match": "abc123", "match_type": "FULL"}
+ {"match": "xyz789", "match_type": "FULL"}
@@ -48614,7 +47713,7 @@ Fields
Example
{
- "from": "abc123",
+ "from": "xyz789",
"to": "abc123"
}
@@ -48799,20 +47898,20 @@ Fields
Example
{
"eq": "abc123",
- "finset": ["abc123"],
- "from": "abc123",
- "gt": "xyz789",
- "gteq": "abc123",
+ "finset": ["xyz789"],
+ "from": "xyz789",
+ "gt": "abc123",
+ "gteq": "xyz789",
"in": ["xyz789"],
- "like": "xyz789",
+ "like": "abc123",
"lt": "abc123",
"lteq": "xyz789",
- "moreq": "abc123",
+ "moreq": "xyz789",
"neq": "xyz789",
- "nin": ["abc123"],
- "notnull": "abc123",
- "null": "xyz789",
- "to": "xyz789"
+ "nin": ["xyz789"],
+ "notnull": "xyz789",
+ "null": "abc123",
+ "to": "abc123"
}
@@ -48945,7 +48044,7 @@ Description
Example
- 987.65
+ 123.45
@@ -49064,7 +48163,7 @@ Fields
Example
- {"template_id": 4}
+ {"template_id": "4"}
@@ -49193,8 +48292,8 @@ Fields
Example
{
"balance": Money,
- "code": "abc123",
- "expiration_date": "xyz789"
+ "code": "xyz789",
+ "expiration_date": "abc123"
}
@@ -49235,7 +48334,7 @@ Fields
Example
- {"gift_card_code": "xyz789"}
+ {"gift_card_code": "abc123"}
@@ -49301,12 +48400,12 @@ Fields
Example
{
- "attribute_id": 987,
+ "attribute_id": 123,
"uid": 4,
"value": 987.65,
"value_id": 987,
- "website_id": 123,
- "website_value": 123.45
+ "website_id": 987,
+ "website_value": 987.65
}
@@ -49466,22 +48565,22 @@ Example
"errors": [CartItemError],
"gift_message": GiftMessage,
"gift_wrapping": GiftWrapping,
- "id": "abc123",
- "is_available": true,
- "max_qty": 123.45,
- "message": "xyz789",
- "min_qty": 123.45,
- "not_available_message": "xyz789",
+ "id": "xyz789",
+ "is_available": false,
+ "max_qty": 987.65,
+ "message": "abc123",
+ "min_qty": 987.65,
+ "not_available_message": "abc123",
"note_from_buyer": [ItemNote],
"note_from_seller": [ItemNote],
"prices": CartItemPrices,
"product": ProductInterface,
- "quantity": 123.45,
- "recipient_email": "xyz789",
- "recipient_name": "abc123",
+ "quantity": 987.65,
+ "recipient_email": "abc123",
+ "recipient_name": "xyz789",
"sender_email": "xyz789",
- "sender_name": "xyz789",
- "uid": 4
+ "sender_name": "abc123",
+ "uid": "4"
}
@@ -49555,12 +48654,12 @@ Example
{
"discounts": [Discount],
"gift_card": GiftCardItem,
- "id": "4",
+ "id": 4,
"order_item": OrderItemInterface,
- "product_name": "abc123",
+ "product_name": "xyz789",
"product_sale_price": Money,
- "product_sku": "abc123",
- "quantity_refunded": 123.45
+ "product_sku": "xyz789",
+ "quantity_refunded": 987.65
}
@@ -49634,12 +48733,12 @@ Example
{
"discounts": [Discount],
"gift_card": GiftCardItem,
- "id": "4",
+ "id": 4,
"order_item": OrderItemInterface,
"product_name": "abc123",
"product_sale_price": Money,
"product_sku": "abc123",
- "quantity_invoiced": 123.45
+ "quantity_invoiced": 987.65
}
@@ -49700,9 +48799,9 @@ Fields
Example
{
- "message": "abc123",
+ "message": "xyz789",
"recipient_email": "xyz789",
- "recipient_name": "abc123",
+ "recipient_name": "xyz789",
"sender_email": "xyz789",
"sender_name": "abc123"
}
@@ -49778,7 +48877,7 @@ Example
"amount": Money,
"custom_giftcard_amount": Money,
"message": "abc123",
- "recipient_email": "abc123",
+ "recipient_email": "xyz789",
"recipient_name": "abc123",
"sender_email": "abc123",
"sender_name": "xyz789"
@@ -49929,7 +49028,7 @@ Fields
Example
{
"discounts": [Discount],
- "eligible_for_return": true,
+ "eligible_for_return": false,
"entered_options": [OrderItemOption],
"gift_card": GiftCardItem,
"gift_message": GiftMessage,
@@ -49939,18 +49038,18 @@ Example
"product": ProductInterface,
"product_name": "xyz789",
"product_sale_price": Money,
- "product_sku": "abc123",
- "product_type": "xyz789",
+ "product_sku": "xyz789",
+ "product_type": "abc123",
"product_url_key": "xyz789",
- "quantity_canceled": 123.45,
+ "quantity_canceled": 987.65,
"quantity_invoiced": 987.65,
- "quantity_ordered": 987.65,
- "quantity_refunded": 123.45,
+ "quantity_ordered": 123.45,
+ "quantity_refunded": 987.65,
"quantity_return_requested": 987.65,
- "quantity_returned": 987.65,
+ "quantity_returned": 123.45,
"quantity_shipped": 123.45,
"selected_options": [OrderItemOption],
- "status": "abc123"
+ "status": "xyz789"
}
@@ -50366,6 +49465,11 @@ currentPage
+
+ rules - [CatalogRule]
+
+ Provides applied catalog rules in the current active cart
+
sale - Int
@@ -50546,15 +49650,15 @@ currentPage
Example
{
- "activity": "xyz789",
- "allow_message": false,
- "allow_open_amount": false,
- "attribute_set_id": 123,
- "canonical_url": "xyz789",
+ "activity": "abc123",
+ "allow_message": true,
+ "allow_open_amount": true,
+ "attribute_set_id": 987,
+ "canonical_url": "abc123",
"categories": [CategoryInterface],
- "category_gear": "abc123",
+ "category_gear": "xyz789",
"climate": "abc123",
- "collar": "abc123",
+ "collar": "xyz789",
"color": 123,
"country_of_manufacture": "abc123",
"created_at": "xyz789",
@@ -50562,9 +49666,9 @@ Example
"custom_attributesV2": ProductCustomAttributes,
"description": ComplexTextValue,
"eco_collection": 123,
- "erin_recommends": 987,
- "features_bags": "abc123",
- "format": 123,
+ "erin_recommends": 123,
+ "features_bags": "xyz789",
+ "format": 987,
"gender": "abc123",
"gift_card_options": [CustomizableOptionInterface],
"gift_message_available": false,
@@ -50574,7 +49678,7 @@ Example
"giftcard_type": "VIRTUAL",
"id": 987,
"image": ProductImage,
- "is_redeemable": false,
+ "is_redeemable": true,
"is_returnable": "xyz789",
"lifetime": 987,
"manufacturer": 987,
@@ -50583,63 +49687,64 @@ Example
"media_gallery": [MediaGalleryInterface],
"media_gallery_entries": [MediaGalleryEntry],
"message_max_length": 123,
- "meta_description": "xyz789",
+ "meta_description": "abc123",
"meta_keyword": "xyz789",
"meta_title": "abc123",
- "min_sale_qty": 123.45,
+ "min_sale_qty": 987.65,
"name": "xyz789",
- "new": 123,
+ "new": 987,
"new_from_date": "xyz789",
- "new_to_date": "xyz789",
- "only_x_left_in_stock": 987.65,
- "open_amount_max": 987.65,
+ "new_to_date": "abc123",
+ "only_x_left_in_stock": 123.45,
+ "open_amount_max": 123.45,
"open_amount_min": 123.45,
"options": [CustomizableOptionInterface],
- "options_container": "abc123",
- "pattern": "xyz789",
- "performance_fabric": 987,
+ "options_container": "xyz789",
+ "pattern": "abc123",
+ "performance_fabric": 123,
"price": ProductPrices,
"price_range": PriceRange,
"price_tiers": [TierPrice],
"product_links": [ProductLinksInterface],
- "purpose": 123,
+ "purpose": 987,
"quantity": 123.45,
- "rating_summary": 987.65,
- "redirect_code": 123,
+ "rating_summary": 123.45,
+ "redirect_code": 987,
"related_products": [ProductInterface],
"relative_url": "abc123",
"review_count": 987,
"reviews": ProductReviews,
- "sale": 123,
+ "rules": [CatalogRule],
+ "sale": 987,
"short_description": ComplexTextValue,
"size": 123,
"sku": "xyz789",
"sleeve": "xyz789",
"small_image": ProductImage,
"special_from_date": "abc123",
- "special_price": 987.65,
- "special_to_date": "abc123",
- "staged": true,
+ "special_price": 123.45,
+ "special_to_date": "xyz789",
+ "staged": false,
"stock_status": "IN_STOCK",
"strap_bags": "xyz789",
- "style_bags": "abc123",
- "style_bottom": "abc123",
- "style_general": "abc123",
- "swatch_image": "xyz789",
+ "style_bags": "xyz789",
+ "style_bottom": "xyz789",
+ "style_general": "xyz789",
+ "swatch_image": "abc123",
"thumbnail": ProductImage,
- "tier_price": 123.45,
+ "tier_price": 987.65,
"tier_prices": [ProductTierPrices],
"type": "CMS_PAGE",
"type_id": "xyz789",
"uid": 4,
- "updated_at": "abc123",
+ "updated_at": "xyz789",
"upsell_products": [ProductInterface],
- "url_key": "abc123",
- "url_path": "xyz789",
+ "url_key": "xyz789",
+ "url_path": "abc123",
"url_rewrites": [UrlRewrite],
- "url_suffix": "xyz789",
+ "url_suffix": "abc123",
"websites": [Website],
- "weight": 123.45
+ "weight": 987.65
}
@@ -50703,8 +49808,8 @@ Example
"customizable_options": [SelectedCustomizableOption],
"gift_card_options": GiftCardOptions,
"product": ProductInterface,
- "quantity": 123.45,
- "uid": "4"
+ "quantity": 987.65,
+ "uid": 4
}
@@ -50772,9 +49877,9 @@ Fields
Example
{
"gift_card": GiftCardItem,
- "id": "4",
+ "id": 4,
"order_item": OrderItemInterface,
- "product_name": "abc123",
+ "product_name": "xyz789",
"product_sale_price": Money,
"product_sku": "xyz789",
"quantity_shipped": 123.45
@@ -50903,60 +50008,13 @@ Fields
Example
{
- "added_at": "abc123",
+ "added_at": "xyz789",
"customizable_options": [SelectedCustomizableOption],
- "description": "abc123",
+ "description": "xyz789",
"gift_card_options": GiftCardOptions,
"id": 4,
"product": ProductInterface,
- "quantity": 123.45
-}
-
-
-
-
-
-
-
- Types
-
- GiftCartAttributeValue
-
-
-
- Description
- Gift card custom attribute value containing array data.
-
-
-
-
-
- Example
- {
- "code": "4",
- "options": ["abc123"]
+ "quantity": 987.65
}
@@ -51007,9 +50065,9 @@ Fields
Example
{
- "from": "xyz789",
+ "from": "abc123",
"message": "abc123",
- "to": "abc123"
+ "to": "xyz789"
}
@@ -51064,8 +50122,8 @@ Fields
Example
{
"from": "abc123",
- "message": "xyz789",
- "to": "abc123"
+ "message": "abc123",
+ "to": "xyz789"
}
@@ -51232,7 +50290,7 @@ Fields
Example
{
- "created_at": "xyz789",
+ "created_at": "abc123",
"dynamic_attributes": [GiftRegistryDynamicAttribute],
"event_name": "abc123",
"items": [GiftRegistryItemInterface],
@@ -51243,7 +50301,7 @@ Example
"shipping_address": CustomerAddress,
"status": "ACTIVE",
"type": GiftRegistryType,
- "uid": 4
+ "uid": "4"
}
@@ -51295,10 +50353,10 @@ Fields
Example
{
- "code": 4,
+ "code": "4",
"group": "EVENT_INFORMATION",
"label": "xyz789",
- "value": "abc123"
+ "value": "xyz789"
}
@@ -51492,8 +50550,8 @@ Possible Types
Example
{
- "code": 4,
- "label": "abc123",
+ "code": "4",
+ "label": "xyz789",
"value": "abc123"
}
@@ -51556,9 +50614,9 @@ Fields
Example
{
- "attribute_group": "xyz789",
- "code": 4,
- "input_type": "xyz789",
+ "attribute_group": "abc123",
+ "code": "4",
+ "input_type": "abc123",
"is_required": false,
"label": "abc123",
"sort_order": 987
@@ -51640,12 +50698,12 @@ Possible Types
Example
{
- "attribute_group": "xyz789",
- "code": "4",
+ "attribute_group": "abc123",
+ "code": 4,
"input_type": "abc123",
"is_required": false,
"label": "abc123",
- "sort_order": 987
+ "sort_order": 123
}
@@ -51708,10 +50766,10 @@ Fields
Example
{
"created_at": "abc123",
- "note": "abc123",
+ "note": "xyz789",
"product": ProductInterface,
"quantity": 123.45,
- "quantity_fulfilled": 123.45,
+ "quantity_fulfilled": 987.65,
"uid": "4"
}
@@ -51791,12 +50849,12 @@ Possible Types
Example
{
- "created_at": "abc123",
- "note": "xyz789",
+ "created_at": "xyz789",
+ "note": "abc123",
"product": ProductInterface,
"quantity": 123.45,
"quantity_fulfilled": 123.45,
- "uid": 4
+ "uid": "4"
}
@@ -51923,7 +50981,7 @@ Example
{
"code": "OUT_OF_STOCK",
"gift_registry_item_uid": 4,
- "gift_registry_uid": 4,
+ "gift_registry_uid": "4",
"message": "xyz789",
"product_uid": 4
}
@@ -52146,9 +51204,9 @@ Example
GiftRegistryRegistrantDynamicAttribute
],
"email": "abc123",
- "firstname": "abc123",
+ "firstname": "xyz789",
"lastname": "xyz789",
- "uid": "4"
+ "uid": 4
}
@@ -52195,9 +51253,9 @@ Fields
Example
{
- "code": "4",
+ "code": 4,
"label": "abc123",
- "value": "xyz789"
+ "value": "abc123"
}
@@ -52263,12 +51321,12 @@ Fields
Example
{
- "event_date": "abc123",
- "event_title": "xyz789",
- "gift_registry_uid": 4,
- "location": "xyz789",
- "name": "xyz789",
- "type": "abc123"
+ "event_date": "xyz789",
+ "event_title": "abc123",
+ "gift_registry_uid": "4",
+ "location": "abc123",
+ "name": "abc123",
+ "type": "xyz789"
}
@@ -52308,12 +51366,6 @@ Fields
The ID assigned to this customer address.
-
-
- customer_address_uid - ID
-
- The unique ID assigned to this customer address.
-
@@ -52321,11 +51373,7 @@ Fields
Example
- {
- "address_data": CustomerAddressInput,
- "address_id": 4,
- "customer_address_uid": 4
-}
+ {"address_data": CustomerAddressInput, "address_id": 4}
@@ -52489,8 +51537,8 @@ Fields
Example
{
- "design": "xyz789",
- "id": "4",
+ "design": "abc123",
+ "id": 4,
"image": GiftWrappingImage,
"price": Money,
"uid": "4"
@@ -52539,8 +51587,8 @@ Fields
Example
{
- "label": "xyz789",
- "url": "xyz789"
+ "label": "abc123",
+ "url": "abc123"
}
@@ -52587,9 +51635,9 @@ Fields
Example
{
- "color": "abc123",
+ "color": "xyz789",
"height": 123,
- "type": "xyz789"
+ "type": "abc123"
}
@@ -52668,8 +51716,8 @@ Example
{
"button_styles": GooglePayButtonStyles,
"code": "abc123",
- "is_visible": true,
- "payment_intent": "abc123",
+ "is_visible": false,
+ "payment_intent": "xyz789",
"payment_source": "abc123",
"sdk_params": [SDKParams],
"sort_order": "xyz789",
@@ -52728,7 +51776,7 @@ Fields
Example
{
- "payment_source": "xyz789",
+ "payment_source": "abc123",
"payments_order_id": "xyz789",
"paypal_order_id": "xyz789"
}
@@ -53096,6 +52144,11 @@ currentPage
{
"activity": "xyz789",
- "attribute_set_id": 987,
- "canonical_url": "xyz789",
+ "attribute_set_id": 123,
+ "canonical_url": "abc123",
"categories": [CategoryInterface],
- "category_gear": "abc123",
- "climate": "xyz789",
- "collar": "xyz789",
+ "category_gear": "xyz789",
+ "climate": "abc123",
+ "collar": "abc123",
"color": 123,
"configurable_options": [ConfigurableProductOptions],
"configurable_product_options_selection": ConfigurableProductOptionsSelection,
@@ -34881,74 +34129,75 @@ Example
"custom_attributesV2": ProductCustomAttributes,
"description": ComplexTextValue,
"eco_collection": 987,
- "erin_recommends": 123,
+ "erin_recommends": 987,
"features_bags": "xyz789",
- "format": 123,
+ "format": 987,
"gender": "xyz789",
- "gift_message_available": true,
- "gift_wrapping_available": true,
+ "gift_message_available": false,
+ "gift_wrapping_available": false,
"gift_wrapping_price": Money,
"id": 123,
"image": ProductImage,
"is_returnable": "xyz789",
- "manufacturer": 987,
- "material": "xyz789",
- "max_sale_qty": 123.45,
+ "manufacturer": 123,
+ "material": "abc123",
+ "max_sale_qty": 987.65,
"media_gallery": [MediaGalleryInterface],
"media_gallery_entries": [MediaGalleryEntry],
"meta_description": "abc123",
- "meta_keyword": "abc123",
+ "meta_keyword": "xyz789",
"meta_title": "xyz789",
"min_sale_qty": 123.45,
- "name": "xyz789",
- "new": 123,
+ "name": "abc123",
+ "new": 987,
"new_from_date": "abc123",
"new_to_date": "abc123",
- "only_x_left_in_stock": 987.65,
+ "only_x_left_in_stock": 123.45,
"options": [CustomizableOptionInterface],
- "options_container": "xyz789",
+ "options_container": "abc123",
"pattern": "xyz789",
- "performance_fabric": 123,
+ "performance_fabric": 987,
"price": ProductPrices,
"price_range": PriceRange,
"price_tiers": [TierPrice],
"product_links": [ProductLinksInterface],
- "purpose": 987,
- "quantity": 123.45,
+ "purpose": 123,
+ "quantity": 987.65,
"rating_summary": 123.45,
- "redirect_code": 123,
+ "redirect_code": 987,
"related_products": [ProductInterface],
"relative_url": "xyz789",
- "review_count": 123,
+ "review_count": 987,
"reviews": ProductReviews,
- "sale": 123,
+ "rules": [CatalogRule],
+ "sale": 987,
"short_description": ComplexTextValue,
"size": 123,
"sku": "xyz789",
- "sleeve": "abc123",
+ "sleeve": "xyz789",
"small_image": ProductImage,
- "special_from_date": "xyz789",
- "special_price": 123.45,
+ "special_from_date": "abc123",
+ "special_price": 987.65,
"special_to_date": "xyz789",
"staged": true,
"stock_status": "IN_STOCK",
- "strap_bags": "xyz789",
- "style_bags": "abc123",
- "style_bottom": "xyz789",
- "style_general": "xyz789",
+ "strap_bags": "abc123",
+ "style_bags": "xyz789",
+ "style_bottom": "abc123",
+ "style_general": "abc123",
"swatch_image": "abc123",
"thumbnail": ProductImage,
"tier_price": 987.65,
"tier_prices": [ProductTierPrices],
"type": "CMS_PAGE",
"type_id": "xyz789",
- "uid": 4,
- "updated_at": "abc123",
+ "uid": "4",
+ "updated_at": "xyz789",
"upsell_products": [ProductInterface],
"url_key": "abc123",
- "url_path": "xyz789",
+ "url_path": "abc123",
"url_rewrites": [UrlRewrite],
- "url_suffix": "xyz789",
+ "url_suffix": "abc123",
"variants": [ConfigurableVariant],
"websites": [Website],
"weight": 987.65
@@ -35010,7 +34259,7 @@ Example
{
"customizable_options": [CustomizableOptionInput],
"data": CartItemInput,
- "parent_sku": "xyz789",
+ "parent_sku": "abc123",
"variant_sku": "abc123"
}
@@ -35068,8 +34317,8 @@ Fields
Example
{
"attribute_code": "abc123",
- "label": "xyz789",
- "uid": 4,
+ "label": "abc123",
+ "uid": "4",
"values": [ConfigurableProductOptionValue]
}
@@ -35133,9 +34382,9 @@ Example
{
"is_available": false,
"is_use_default": true,
- "label": "xyz789",
+ "label": "abc123",
"swatch": SwatchDataInterface,
- "uid": 4
+ "uid": "4"
}
@@ -35232,14 +34481,14 @@ Example
{
"attribute_code": "abc123",
"attribute_id": "xyz789",
- "attribute_id_v2": 123,
+ "attribute_id_v2": 987,
"attribute_uid": "4",
- "id": 123,
+ "id": 987,
"label": "abc123",
- "position": 987,
- "product_id": 123,
+ "position": 123,
+ "product_id": 987,
"uid": 4,
- "use_default": false,
+ "use_default": true,
"values": [ConfigurableProductOptionsValues]
}
@@ -35373,13 +34622,13 @@ Fields
Example
{
- "default_label": "abc123",
- "label": "xyz789",
+ "default_label": "xyz789",
+ "label": "abc123",
"store_label": "abc123",
"swatch_data": SwatchDataInterface,
"uid": "4",
- "use_default_value": true,
- "value_index": 123
+ "use_default_value": false,
+ "value_index": 987
}
@@ -35443,7 +34692,7 @@ Example
"configurable_options": [SelectedConfigurableOption],
"customizable_options": [SelectedCustomizableOption],
"product": ProductInterface,
- "quantity": 987.65,
+ "quantity": 123.45,
"uid": 4
}
@@ -35581,7 +34830,7 @@ Example
"description": "xyz789", "id": "4", "product": ProductInterface, - "quantity": 987.65 + "quantity": 123.45 }{
"confirmation_key": "xyz789",
- "order_id": "4"
+ "order_id": 4
}
Example
{
- "confirmation_key": "xyz789",
+ "confirmation_key": "abc123",
"email": "xyz789"
}
@@ -35719,8 +34968,8 @@ Fields
Example
{
- "confirmation_key": "abc123",
- "order_id": 4
+ "confirmation_key": "xyz789",
+ "order_id": "4"
}
Fields
Example
{
- "comment": "xyz789",
+ "comment": "abc123",
"email": "abc123",
- "name": "xyz789",
- "telephone": "abc123"
+ "name": "abc123",
+ "telephone": "xyz789"
}
Fields
Example
-{"status": true}
+ {"status": false}
Fields
Example
-{"requisitionListItemUids": ["4"]}
+ {"requisitionListItemUids": [4]}
Fields
Example
{
"available_regions": [Region],
- "full_name_english": "xyz789",
- "full_name_locale": "abc123",
+ "full_name_english": "abc123",
+ "full_name_locale": "xyz789",
"id": "xyz789",
- "three_letter_abbreviation": "xyz789",
+ "three_letter_abbreviation": "abc123",
"two_letter_abbreviation": "abc123"
}
@@ -37851,7 +37100,7 @@ Example
GiftRegistryDynamicAttributeInput ], "event_name": "xyz789", - "gift_registry_type_uid": 4, + "gift_registry_type_uid": "4", "message": "abc123", "privacy_settings": "PRIVATE", "registrants": [AddGiftRegistryRegistrantInput], @@ -37932,7 +37181,7 @@Fields
Example
-{"cart_uid": 4}
+ {"cart_uid": "4"}
Fields
Example
{
"response_message": "xyz789",
- "result": 123,
- "result_code": 987,
+ "result": 987,
+ "result_code": 123,
"secure_token": "xyz789",
"secure_token_id": "xyz789"
}
@@ -38099,7 +37348,7 @@ Example
{
"cartId": "xyz789",
"location": "PRODUCT_DETAIL",
- "methodCode": "abc123",
+ "methodCode": "xyz789",
"paymentSource": "abc123",
"vaultIntent": false
}
@@ -38162,11 +37411,11 @@ Fields
Example
{
- "amount": 123.45,
+ "amount": 987.65,
"currency_code": "xyz789",
"id": "xyz789",
"mp_order_id": "xyz789",
- "status": "abc123"
+ "status": "xyz789"
}
@@ -38232,10 +37481,10 @@ Fields
Example
{
- "nickname": "abc123",
+ "nickname": "xyz789",
"ratings": [ProductReviewRatingInput],
- "sku": "xyz789",
- "summary": "xyz789",
+ "sku": "abc123",
+ "summary": "abc123",
"text": "xyz789"
}
@@ -38322,7 +37571,7 @@ Fields
Example
- {"currency": "AFN", "value": 987.65}
+ {"currency": "AFN", "value": 123.45}
@@ -38432,8 +37681,8 @@ Fields
Example
{
- "description": "abc123",
- "name": "abc123"
+ "description": "xyz789",
+ "name": "xyz789"
}
@@ -38521,7 +37770,7 @@ Fields
Example
{
"card_description": "xyz789",
- "setup_token_id": "abc123"
+ "setup_token_id": "xyz789"
}
@@ -38657,7 +37906,7 @@ Fields
Example
- {"setup_token": "abc123"}
+ {"setup_token": "xyz789"}
@@ -38803,8 +38052,8 @@ Example
{
"cc_exp_month": 987,
"cc_exp_year": 123,
- "cc_last_4": 123,
- "cc_type": "abc123"
+ "cc_last_4": 987,
+ "cc_type": "xyz789"
}
Example
"product_name": "xyz789", "product_sale_price": Money, "product_sku": "xyz789", - "quantity_refunded": 123.45 + "quantity_refunded": 987.65 } @@ -39217,11 +38466,11 @@Fields
Example
{
"available_currency_codes": ["xyz789"],
- "base_currency_code": "xyz789",
+ "base_currency_code": "abc123",
"base_currency_symbol": "xyz789",
"default_display_currecy_code": "xyz789",
- "default_display_currecy_symbol": "xyz789",
- "default_display_currency_code": "xyz789",
+ "default_display_currecy_symbol": "abc123",
+ "default_display_currency_code": "abc123",
"default_display_currency_symbol": "xyz789",
"exchange_rates": [ExchangeRate]
}
@@ -40600,12 +39849,12 @@ Possible Types
Example
{
"code": 4,
- "default_value": "abc123",
+ "default_value": "xyz789",
"entity_type": "CATALOG_PRODUCT",
"frontend_class": "abc123",
"frontend_input": "BOOLEAN",
"is_required": true,
- "is_unique": true,
+ "is_unique": false,
"label": "xyz789",
"options": [CustomAttributeOptionInterface]
}
@@ -40671,7 +39920,7 @@ Possible Types
Example
{
- "is_default": false,
+ "is_default": true,
"label": "xyz789",
"value": "abc123"
}
@@ -40846,9 +40095,9 @@ giftRegistryUi
group - CustomerGroupStorefront
+ group - CustomerGroup
group_id - Int
@@ -40858,9 +40107,10 @@ giftRegistryUi
id - ID!
+ id - Int
+ id is not needed as part of Customer, because on the server side, it can be identified based on the customer token used for authentication. There is no need to know customer ID on the client side.
is_subscribed - Boolean
@@ -41127,7 +40377,7 @@ currentPage The role name and permissions assigned to the company user.
segments - [CustomerSegmentStorefront]
+ segments - [CustomerSegment]
attributeCodes
The first name of the person associated with the shipping/billing address.
- id - Int
-
- The ID of a CustomerAddress object. Use uid instead.
+ id - Int
+ The ID of a CustomerAddress object.
lastname - String
@@ -41426,11 +40675,6 @@ attributeCodes
The customer's telephone number.
-
- uid - ID
-
- The unique ID for a CustomerAddress object.
-
vat_id - String
@@ -41444,29 +40688,28 @@ attributeCodes
Example
{
- "city": "xyz789",
+ "city": "abc123",
"company": "xyz789",
"country_code": "AF",
- "country_id": "abc123",
+ "country_id": "xyz789",
"custom_attributes": [CustomerAddressAttribute],
"custom_attributesV2": [AttributeValueInterface],
"customer_id": 987,
- "default_billing": true,
- "default_shipping": true,
+ "default_billing": false,
+ "default_shipping": false,
"extension_attributes": [CustomerAddressAttribute],
"fax": "xyz789",
"firstname": "abc123",
"id": 987,
- "lastname": "xyz789",
+ "lastname": "abc123",
"middlename": "abc123",
"postcode": "abc123",
- "prefix": "abc123",
+ "prefix": "xyz789",
"region": CustomerAddressRegion,
- "region_id": 987,
+ "region_id": 123,
"street": ["xyz789"],
"suffix": "xyz789",
- "telephone": "abc123",
- "uid": 4,
+ "telephone": "xyz789",
"vat_id": "xyz789"
}
@@ -41514,7 +40757,7 @@ Fields
Example
{
"attribute_code": "abc123",
- "value": "abc123"
+ "value": "xyz789"
}
@@ -41563,7 +40806,7 @@ Fields
Example
{
"attribute_code": "xyz789",
- "value": "abc123"
+ "value": "xyz789"
}
@@ -41715,24 +40958,24 @@ Fields
Example
{
- "city": "abc123",
+ "city": "xyz789",
"company": "abc123",
"country_code": "AF",
"country_id": "AF",
"custom_attributes": [CustomerAddressAttributeInput],
"custom_attributesV2": [AttributeValueInput],
- "default_billing": false,
+ "default_billing": true,
"default_shipping": false,
"fax": "xyz789",
- "firstname": "xyz789",
- "lastname": "abc123",
- "middlename": "abc123",
+ "firstname": "abc123",
+ "lastname": "xyz789",
+ "middlename": "xyz789",
"postcode": "xyz789",
"prefix": "xyz789",
"region": CustomerAddressRegionInput,
"street": ["xyz789"],
- "suffix": "xyz789",
- "telephone": "abc123",
+ "suffix": "abc123",
+ "telephone": "xyz789",
"vat_id": "xyz789"
}
@@ -41785,7 +41028,7 @@ Fields
Example
{
"region": "abc123",
- "region_code": "abc123",
+ "region_code": "xyz789",
"region_id": 987
}
@@ -41840,9 +41083,9 @@ Fields
Example
{
- "region": "abc123",
- "region_code": "abc123",
- "region_id": 987
+ "region": "xyz789",
+ "region_code": "xyz789",
+ "region_id": 123
}
@@ -41995,13 +41238,13 @@ Example
"code": "4",
"default_value": "xyz789",
"entity_type": "CATALOG_PRODUCT",
- "frontend_class": "xyz789",
+ "frontend_class": "abc123",
"frontend_input": "BOOLEAN",
"input_filter": "NONE",
"is_required": true,
- "is_unique": true,
+ "is_unique": false,
"label": "abc123",
- "multiline_count": 123,
+ "multiline_count": 987,
"options": [CustomAttributeOptionInterface],
"sort_order": 987,
"validate_rules": [ValidationRule]
@@ -42129,16 +41372,16 @@ Example
"custom_attributes": [AttributeValueInput],
"date_of_birth": "xyz789",
"dob": "abc123",
- "email": "xyz789",
+ "email": "abc123",
"firstname": "abc123",
"gender": 987,
- "is_subscribed": false,
- "lastname": "xyz789",
+ "is_subscribed": true,
+ "lastname": "abc123",
"middlename": "xyz789",
"password": "abc123",
"prefix": "abc123",
"suffix": "abc123",
- "taxvat": "abc123"
+ "taxvat": "xyz789"
}
@@ -42202,8 +41445,8 @@ Example
"date": "abc123",
"download_url": "xyz789",
"order_increment_id": "abc123",
- "remaining_downloads": "abc123",
- "status": "abc123"
+ "remaining_downloads": "xyz789",
+ "status": "xyz789"
}
@@ -42249,11 +41492,11 @@ Example
-
+
- CustomerGroupStorefront
+ CustomerGroup
@@ -42271,9 +41514,9 @@ Fields
- uid - ID!
+ name - String
- The unique ID for a CustomerGroup object.
+ The name of customer group.
@@ -42282,7 +41525,7 @@ Fields
Example
- {"uid": 4}
+ {"name": "xyz789"}
@@ -42391,17 +41634,17 @@ Fields
Example
{
"date_of_birth": "xyz789",
- "dob": "abc123",
- "email": "abc123",
- "firstname": "abc123",
+ "dob": "xyz789",
+ "email": "xyz789",
+ "firstname": "xyz789",
"gender": 987,
- "is_subscribed": true,
- "lastname": "xyz789",
+ "is_subscribed": false,
+ "lastname": "abc123",
"middlename": "xyz789",
"password": "abc123",
- "prefix": "abc123",
- "suffix": "xyz789",
- "taxvat": "abc123"
+ "prefix": "xyz789",
+ "suffix": "abc123",
+ "taxvat": "xyz789"
}
@@ -42635,34 +41878,34 @@ Example
"applied_gift_cards": [ApplyGiftCardToOrder],
"available_actions": ["REORDER"],
"billing_address": OrderAddress,
- "carrier": "xyz789",
+ "carrier": "abc123",
"comments": [SalesCommentItem],
"created_at": "xyz789",
"credit_memos": [CreditMemo],
"customer_info": OrderCustomerInfo,
- "email": "xyz789",
+ "email": "abc123",
"gift_message": GiftMessage,
- "gift_receipt_included": false,
+ "gift_receipt_included": true,
"gift_wrapping": GiftWrapping,
- "grand_total": 123.45,
+ "grand_total": 987.65,
"id": 4,
"increment_id": "xyz789",
"invoices": [Invoice],
"is_virtual": false,
"items": [OrderItemInterface],
"items_eligible_for_return": [OrderItemInterface],
- "number": "abc123",
- "order_date": "abc123",
- "order_number": "abc123",
+ "number": "xyz789",
+ "order_date": "xyz789",
+ "order_number": "xyz789",
"order_status_change_date": "xyz789",
"payment_methods": [OrderPaymentMethod],
- "printed_card_included": true,
+ "printed_card_included": false,
"returns": Returns,
"shipments": [OrderShipment],
"shipping_address": OrderAddress,
"shipping_method": "abc123",
- "status": "abc123",
- "token": "abc123",
+ "status": "xyz789",
+ "token": "xyz789",
"total": OrderTotal
}
@@ -42962,16 +42205,16 @@ Example
-
+
- CustomerSegmentStorefront
+ CustomerSegment
Description
- Customer segment details
+ Customer segment.
Fields
@@ -42984,9 +42227,19 @@ Fields
- uid - ID!
+ apply_to - CustomerSegmentApplyTo!
+
+ Customer segment is applicable to visitor, registered customer or both.
+
+
+ description - String
+
+ Customer segment description.
+
+
+ name - String!
- The unique ID for a CustomerSegment object.
+ Customer segment name.
@@ -42995,7 +42248,63 @@ Fields
Example
- {"uid": 4}
+ {
+ "apply_to": "BOTH",
+ "description": "xyz789",
+ "name": "abc123"
+}
+
+
+
+
+
+
+
+ Types
+
+ CustomerSegmentApplyTo
+
+
+
+ Description
+ Customer segment is applicable to visitor, registered customers or both.
+
+
+ Values
+
+
+
+ Enum Value
+ Description
+
+
+
+
+
+ BOTH
+
+ Customer segment is applicable to visitor and registered customers.
+
+
+
+ REGISTERED
+
+ Customer segment is applicable to registered customers.
+
+
+
+ VISITOR
+
+ Customer segment is applicable to visitors/guests.
+
+
+
+
+
+
+
+ Example
+ "BOTH"
@@ -43175,10 +42484,10 @@ Fields
Example
{
- "action": "xyz789",
+ "action": "abc123",
"actual_balance": Money,
"balance_change": Money,
- "date_time_changed": "abc123"
+ "date_time_changed": "xyz789"
}
@@ -43218,7 +42527,7 @@ Fields
Example
- {"token": "abc123"}
+ {"token": "xyz789"}
@@ -43326,18 +42635,18 @@ Fields
Example
{
- "allow_remote_shopping_assistance": false,
+ "allow_remote_shopping_assistance": true,
"custom_attributes": [AttributeValueInput],
- "date_of_birth": "abc123",
- "dob": "abc123",
+ "date_of_birth": "xyz789",
+ "dob": "xyz789",
"firstname": "xyz789",
- "gender": 123,
- "is_subscribed": false,
- "lastname": "abc123",
+ "gender": 987,
+ "is_subscribed": true,
+ "lastname": "xyz789",
"middlename": "xyz789",
- "prefix": "xyz789",
+ "prefix": "abc123",
"suffix": "xyz789",
- "taxvat": "abc123"
+ "taxvat": "xyz789"
}
@@ -43409,12 +42718,12 @@ Fields
Example
{
- "option_id": 123,
+ "option_id": 987,
"product_sku": "abc123",
- "required": true,
- "sort_order": 123,
- "title": "xyz789",
- "uid": "4",
+ "required": false,
+ "sort_order": 987,
+ "title": "abc123",
+ "uid": 4,
"value": CustomizableAreaValue
}
@@ -43476,11 +42785,11 @@ Fields
Example
{
- "max_characters": 987,
- "price": 123.45,
+ "max_characters": 123,
+ "price": 987.65,
"price_type": "FIXED",
"sku": "abc123",
- "uid": "4"
+ "uid": 4
}
@@ -43549,8 +42858,8 @@ Example
{
"option_id": 123,
"required": true,
- "sort_order": 123,
- "title": "abc123",
+ "sort_order": 987,
+ "title": "xyz789",
"uid": "4",
"value": [CustomizableCheckboxValue]
}
@@ -43624,12 +42933,12 @@ Fields
Example
{
"option_type_id": 123,
- "price": 123.45,
+ "price": 987.65,
"price_type": "FIXED",
- "sku": "xyz789",
- "sort_order": 123,
+ "sku": "abc123",
+ "sort_order": 987,
"title": "abc123",
- "uid": "4"
+ "uid": 4
}
@@ -43701,12 +43010,12 @@ Fields
Example
{
- "option_id": 987,
+ "option_id": 123,
"product_sku": "xyz789",
"required": true,
- "sort_order": 123,
+ "sort_order": 987,
"title": "xyz789",
- "uid": "4",
+ "uid": 4,
"value": CustomizableDateValue
}
@@ -43897,7 +43206,7 @@ Example
"option_id": 987,
"required": false,
"sort_order": 123,
- "title": "xyz789",
+ "title": "abc123",
"uid": 4,
"value": [CustomizableDropDownValue]
}
@@ -43971,11 +43280,11 @@ Fields
Example
{
"option_type_id": 987,
- "price": 123.45,
+ "price": 987.65,
"price_type": "FIXED",
"sku": "xyz789",
- "sort_order": 987,
- "title": "abc123",
+ "sort_order": 123,
+ "title": "xyz789",
"uid": 4
}
@@ -44050,10 +43359,10 @@ Example
{
"option_id": 987,
"product_sku": "abc123",
- "required": false,
+ "required": true,
"sort_order": 123,
"title": "xyz789",
- "uid": 4,
+ "uid": "4",
"value": CustomizableFieldValue
}
@@ -44118,7 +43427,7 @@ Example
"max_characters": 987,
"price": 123.45,
"price_type": "FIXED",
- "sku": "abc123",
+ "sku": "xyz789",
"uid": "4"
}
@@ -44193,9 +43502,9 @@ Example
{
"option_id": 987,
"product_sku": "xyz789",
- "required": true,
+ "required": false,
"sort_order": 123,
- "title": "abc123",
+ "title": "xyz789",
"uid": 4,
"value": CustomizableFileValue
}
@@ -44270,10 +43579,10 @@ Example
{
"file_extension": "xyz789",
"image_size_x": 987,
- "image_size_y": 987,
+ "image_size_y": 123,
"price": 123.45,
"price_type": "FIXED",
- "sku": "abc123",
+ "sku": "xyz789",
"uid": 4
}
@@ -44341,11 +43650,11 @@ Fields
Example
{
- "option_id": 123,
- "required": false,
- "sort_order": 987,
+ "option_id": 987,
+ "required": true,
+ "sort_order": 123,
"title": "xyz789",
- "uid": "4",
+ "uid": 4,
"value": [CustomizableMultipleValue]
}
@@ -44418,12 +43727,12 @@ Fields
Example
{
"option_type_id": 123,
- "price": 123.45,
+ "price": 987.65,
"price_type": "FIXED",
- "sku": "abc123",
+ "sku": "xyz789",
"sort_order": 987,
"title": "abc123",
- "uid": "4"
+ "uid": 4
}
@@ -44479,7 +43788,7 @@ Example
{
"id": 123,
"uid": 4,
- "value_string": "abc123"
+ "value_string": "xyz789"
}
@@ -44595,9 +43904,9 @@ Example
{
"option_id": 123,
"required": true,
- "sort_order": 123,
+ "sort_order": 987,
"title": "abc123",
- "uid": "4"
+ "uid": 4
}
@@ -44659,12 +43968,12 @@ Possible Types
-
+
-
+
@@ -44747,7 +44056,7 @@ Example
{
"option_id": 987,
"required": false,
- "sort_order": 987,
+ "sort_order": 123,
"title": "xyz789",
"uid": 4,
"value": [CustomizableRadioValue]
@@ -44822,10 +44131,10 @@ Fields
Example
{
"option_type_id": 123,
- "price": 987.65,
+ "price": 123.45,
"price_type": "FIXED",
- "sku": "abc123",
- "sort_order": 987,
+ "sku": "xyz789",
+ "sort_order": 123,
"title": "abc123",
"uid": "4"
}
@@ -44906,7 +44215,7 @@ Fields
Example
- {"success": true}
+ {"success": false}
@@ -45075,7 +44384,7 @@ Fields
Example
{
"errors": [NegotiableQuoteInvalidStateError],
- "quote_uid": 4
+ "quote_uid": "4"
}
@@ -45155,7 +44464,7 @@ Fields
Example
- {"template_id": 4}
+ {"template_id": "4"}
@@ -45191,7 +44500,7 @@ Fields
Example
- {"quote_uids": ["4"]}
+ {"quote_uids": [4]}
@@ -45321,7 +44630,7 @@ Fields
Example
{
"customerPaymentTokens": CustomerPaymentTokens,
- "result": true
+ "result": false
}
@@ -45450,7 +44759,7 @@ Fields
Example
- {"approval_rule_uids": [4]}
+ {"approval_rule_uids": ["4"]}
@@ -45616,7 +44925,7 @@ Fields
Example
- {"status": true, "wishlists": [Wishlist]}
+ {"status": false, "wishlists": [Wishlist]}
@@ -45689,10 +44998,10 @@ Example
"amount": Money,
"applied_to": "ITEM",
"coupon": AppliedCoupon,
- "is_discounting_locked": false,
+ "is_discounting_locked": true,
"label": "abc123",
- "type": "xyz789",
- "value": 987.65
+ "type": "abc123",
+ "value": 123.45
}
@@ -45813,7 +45122,7 @@ Example
"customizable_options": [SelectedCustomizableOption],
"discount": [Discount],
"errors": [CartItemError],
- "id": "xyz789",
+ "id": "abc123",
"is_available": false,
"links": [DownloadableProductLinks],
"max_qty": 987.65,
@@ -45823,9 +45132,9 @@ Example
"note_from_seller": [ItemNote],
"prices": CartItemPrices,
"product": ProductInterface,
- "quantity": 123.45,
+ "quantity": 987.65,
"samples": [DownloadableProductSamples],
- "uid": "4"
+ "uid": 4
}
@@ -45903,12 +45212,12 @@ Example
{
"discounts": [Discount],
"downloadable_links": [DownloadableItemsLinks],
- "id": "4",
+ "id": 4,
"order_item": OrderItemInterface,
- "product_name": "xyz789",
+ "product_name": "abc123",
"product_sale_price": Money,
- "product_sku": "xyz789",
- "quantity_refunded": 987.65
+ "product_sku": "abc123",
+ "quantity_refunded": 123.45
}
@@ -46032,12 +45341,12 @@ Example
{
"discounts": [Discount],
"downloadable_links": [DownloadableItemsLinks],
- "id": 4,
+ "id": "4",
"order_item": OrderItemInterface,
- "product_name": "abc123",
+ "product_name": "xyz789",
"product_sale_price": Money,
- "product_sku": "abc123",
- "quantity_invoiced": 987.65
+ "product_sku": "xyz789",
+ "quantity_invoiced": 123.45
}
@@ -46090,7 +45399,7 @@ Example
{
"sort_order": 987,
"title": "xyz789",
- "uid": 4
+ "uid": "4"
}
@@ -46243,7 +45552,7 @@ Example
{
"discounts": [Discount],
"downloadable_links": [DownloadableItemsLinks],
- "eligible_for_return": true,
+ "eligible_for_return": false,
"entered_options": [OrderItemOption],
"gift_message": GiftMessage,
"gift_wrapping": GiftWrapping,
@@ -46252,18 +45561,18 @@ Example
"product": ProductInterface,
"product_name": "xyz789",
"product_sale_price": Money,
- "product_sku": "xyz789",
- "product_type": "abc123",
+ "product_sku": "abc123",
+ "product_type": "xyz789",
"product_url_key": "xyz789",
- "quantity_canceled": 123.45,
+ "quantity_canceled": 987.65,
"quantity_invoiced": 123.45,
- "quantity_ordered": 123.45,
- "quantity_refunded": 123.45,
- "quantity_return_requested": 123.45,
+ "quantity_ordered": 987.65,
+ "quantity_refunded": 987.65,
+ "quantity_return_requested": 987.65,
"quantity_returned": 987.65,
"quantity_shipped": 987.65,
"selected_options": [OrderItemOption],
- "status": "abc123"
+ "status": "xyz789"
}
@@ -46649,6 +45958,11 @@ currentPage
+
+ rules - [CatalogRule]
+
+ Provides applied catalog rules in the current active cart
+
sale - Int
@@ -46824,15 +46138,15 @@ currentPage
Example
{
- "activity": "abc123",
+ "activity": "xyz789",
"attribute_set_id": 987,
"canonical_url": "xyz789",
"categories": [CategoryInterface],
- "category_gear": "xyz789",
+ "category_gear": "abc123",
"climate": "abc123",
- "collar": "xyz789",
- "color": 123,
- "country_of_manufacture": "xyz789",
+ "collar": "abc123",
+ "color": 987,
+ "country_of_manufacture": "abc123",
"created_at": "abc123",
"crosssell_products": [ProductInterface],
"custom_attributesV2": ProductCustomAttributes,
@@ -46843,77 +46157,78 @@ Example
"downloadable_product_samples": [
DownloadableProductSamples
],
- "eco_collection": 123,
- "erin_recommends": 123,
- "features_bags": "xyz789",
- "format": 987,
- "gender": "xyz789",
+ "eco_collection": 987,
+ "erin_recommends": 987,
+ "features_bags": "abc123",
+ "format": 123,
+ "gender": "abc123",
"gift_message_available": true,
- "gift_wrapping_available": true,
+ "gift_wrapping_available": false,
"gift_wrapping_price": Money,
- "id": 987,
+ "id": 123,
"image": ProductImage,
"is_returnable": "xyz789",
"links_purchased_separately": 123,
"links_title": "abc123",
- "manufacturer": 987,
+ "manufacturer": 123,
"material": "abc123",
"max_sale_qty": 987.65,
"media_gallery": [MediaGalleryInterface],
"media_gallery_entries": [MediaGalleryEntry],
- "meta_description": "xyz789",
- "meta_keyword": "xyz789",
+ "meta_description": "abc123",
+ "meta_keyword": "abc123",
"meta_title": "abc123",
- "min_sale_qty": 123.45,
- "name": "xyz789",
- "new": 123,
- "new_from_date": "abc123",
+ "min_sale_qty": 987.65,
+ "name": "abc123",
+ "new": 987,
+ "new_from_date": "xyz789",
"new_to_date": "abc123",
"only_x_left_in_stock": 987.65,
"options": [CustomizableOptionInterface],
"options_container": "xyz789",
- "pattern": "xyz789",
+ "pattern": "abc123",
"performance_fabric": 987,
"price": ProductPrices,
"price_range": PriceRange,
"price_tiers": [TierPrice],
"product_links": [ProductLinksInterface],
- "purpose": 987,
+ "purpose": 123,
"quantity": 987.65,
- "rating_summary": 987.65,
+ "rating_summary": 123.45,
"redirect_code": 123,
"related_products": [ProductInterface],
"relative_url": "xyz789",
"review_count": 987,
"reviews": ProductReviews,
- "sale": 987,
+ "rules": [CatalogRule],
+ "sale": 123,
"short_description": ComplexTextValue,
- "size": 987,
- "sku": "abc123",
- "sleeve": "abc123",
+ "size": 123,
+ "sku": "xyz789",
+ "sleeve": "xyz789",
"small_image": ProductImage,
"special_from_date": "abc123",
"special_price": 123.45,
"special_to_date": "xyz789",
- "staged": false,
+ "staged": true,
"stock_status": "IN_STOCK",
"strap_bags": "abc123",
"style_bags": "xyz789",
- "style_bottom": "abc123",
+ "style_bottom": "xyz789",
"style_general": "abc123",
"swatch_image": "abc123",
"thumbnail": ProductImage,
- "tier_price": 123.45,
+ "tier_price": 987.65,
"tier_prices": [ProductTierPrices],
"type": "CMS_PAGE",
- "type_id": "abc123",
- "uid": "4",
- "updated_at": "xyz789",
+ "type_id": "xyz789",
+ "uid": 4,
+ "updated_at": "abc123",
"upsell_products": [ProductInterface],
"url_key": "xyz789",
- "url_path": "abc123",
+ "url_path": "xyz789",
"url_rewrites": [UrlRewrite],
- "url_suffix": "abc123",
+ "url_suffix": "xyz789",
"websites": [Website]
}
@@ -47075,17 +46390,17 @@ Fields
Example
{
- "id": 123,
- "is_shareable": true,
+ "id": 987,
+ "is_shareable": false,
"link_type": "FILE",
"number_of_downloads": 123,
- "price": 987.65,
- "sample_file": "abc123",
+ "price": 123.45,
+ "sample_file": "xyz789",
"sample_type": "FILE",
- "sample_url": "abc123",
+ "sample_url": "xyz789",
"sort_order": 123,
"title": "xyz789",
- "uid": 4
+ "uid": "4"
}
@@ -47126,7 +46441,7 @@ Fields
Example
- {"link_id": 987}
+ {"link_id": 123}
@@ -47197,12 +46512,12 @@ Fields
Example
{
- "id": 123,
- "sample_file": "abc123",
+ "id": 987,
+ "sample_file": "xyz789",
"sample_type": "FILE",
"sample_url": "abc123",
- "sort_order": 987,
- "title": "abc123"
+ "sort_order": 123,
+ "title": "xyz789"
}
@@ -47273,7 +46588,7 @@ Example
"product": ProductInterface,
"quantity": 987.65,
"samples": [DownloadableProductSamples],
- "uid": 4
+ "uid": "4"
}
@@ -47349,7 +46664,7 @@ Fields
Example
{
- "added_at": "xyz789",
+ "added_at": "abc123",
"customizable_options": [SelectedCustomizableOption],
"description": "xyz789",
"id": "4",
@@ -47404,8 +46719,8 @@ Fields
Example
{
- "duplicated_quote_uid": "4",
- "quote_uid": 4
+ "duplicated_quote_uid": 4,
+ "quote_uid": "4"
}
@@ -47665,7 +46980,7 @@ Example
{
"items": [DynamicBlock],
"page_info": SearchResultPageInfo,
- "total_count": 123
+ "total_count": 987
}
@@ -47718,11 +47033,7 @@ Fields
Example
- {
- "dynamic_block_uids": ["4"],
- "locations": ["CONTENT"],
- "type": "SPECIFIED"
-}
+ {"dynamic_block_uids": [4], "locations": ["CONTENT"], "type": "SPECIFIED"}
@@ -47769,8 +47080,8 @@ Fields
Example
{
- "attribute_code": "xyz789",
- "value": "xyz789"
+ "attribute_code": "abc123",
+ "value": "abc123"
}
@@ -47817,7 +47128,10 @@ Fields
Example
- {"uid": 4, "value": "abc123"}
+ {
+ "uid": "4",
+ "value": "xyz789"
+}
@@ -47885,9 +47199,9 @@ Fields
Example
{
- "canonical_url": "xyz789",
- "entity_uid": 4,
- "id": 123,
+ "canonical_url": "abc123",
+ "entity_uid": "4",
+ "id": 987,
"redirectCode": 123,
"relative_url": "xyz789",
"type": "CMS_PAGE"
@@ -47959,7 +47273,7 @@ Possible Types
Example
{
"code": "PRODUCT_NOT_FOUND",
- "message": "abc123"
+ "message": "xyz789"
}
@@ -48022,7 +47336,7 @@ Possible Types
Example
- {"message": "xyz789"}
+ {"message": "abc123"}
@@ -48076,7 +47390,7 @@ Fields
Example
{
"country_code": "AF",
- "postcode": "xyz789",
+ "postcode": "abc123",
"region": CustomerAddressRegionInput
}
@@ -48128,7 +47442,7 @@ Fields
Example
{
"address": EstimateAddressInput,
- "cart_id": "abc123",
+ "cart_id": "xyz789",
"shipping_method": ShippingMethodInput
}
@@ -48170,93 +47484,6 @@ Fields
Example
{"cart": Cart}
-
-
-
-
-
-
-
- Types
-
- ExchangeExternalCustomerTokenInput
-
-
-
- Description
- Contains details about external customer.
-
-
- Fields
-
-
-
- Input Field
- Description
-
-
-
-
-
- customer - CustomerCreateInput!
-
- An input object that defines the customer characteristics to update.
-
-
-
-
-
-
-
- Example
- {"customer": CustomerCreateInput}
-
-
-
-
-
-
-
- Types
-
- ExchangeExternalCustomerTokenOutput
-
-
-
- Description
- Contains customer token for external customer.
-
-
-
-
-
- Example
- {
- "customer": Customer,
- "token": "xyz789"
-}
@@ -48300,135 +47527,7 @@ Fields
Example
- {"currency_to": "xyz789", "rate": 987.65}
-
-
-
-
-
-
-
- Types
-
- FastlaneConfig
-
-
-
- Fields
-
-
-
- Field Name
- Description
-
-
-
-
- code - String
-
- The payment method code as defined in the payment gateway
-
-
- is_visible - Boolean
-
- Indicates whether the payment method is displayed
-
-
- payment_intent - String
-
- Defines the payment intent (Authorize or Capture
-
-
- payment_source - String
-
- The payment source for the payment method
-
-
- sdk_params - [SDKParams]
-
- The PayPal parameters required to load the JS SDK
-
-
- sort_order - String
-
- The relative order the payment method is displayed on the checkout page
-
-
- three_ds_mode - ThreeDSMode
-
- 3DS mode
-
-
- title - String
-
- The name displayed for the payment method
-
-
-
-
-
-
-
- Example
- {
- "code": "xyz789",
- "is_visible": false,
- "payment_intent": "abc123",
- "payment_source": "abc123",
- "sdk_params": [SDKParams],
- "sort_order": "abc123",
- "three_ds_mode": "OFF",
- "title": "xyz789"
-}
-
-
-
-
-
-
-
- Types
-
- FastlaneMethodInput
-
-
-
- Description
- Fastlane Payment inputs
-
-
-
-
-
- Example
- {
- "payment_source": "abc123",
- "paypal_fastlane_token": "abc123"
-}
+ {"currency_to": "abc123", "rate": 123.45}
@@ -48475,7 +47574,7 @@ Fields
Example
{
- "eq": "abc123",
+ "eq": "xyz789",
"in": ["xyz789"]
}
@@ -48567,7 +47666,7 @@ Fields
Example
- {"match": "abc123", "match_type": "FULL"}
+ {"match": "xyz789", "match_type": "FULL"}
@@ -48614,7 +47713,7 @@ Fields
Example
{
- "from": "abc123",
+ "from": "xyz789",
"to": "abc123"
}
@@ -48799,20 +47898,20 @@ Fields
Example
{
"eq": "abc123",
- "finset": ["abc123"],
- "from": "abc123",
- "gt": "xyz789",
- "gteq": "abc123",
+ "finset": ["xyz789"],
+ "from": "xyz789",
+ "gt": "abc123",
+ "gteq": "xyz789",
"in": ["xyz789"],
- "like": "xyz789",
+ "like": "abc123",
"lt": "abc123",
"lteq": "xyz789",
- "moreq": "abc123",
+ "moreq": "xyz789",
"neq": "xyz789",
- "nin": ["abc123"],
- "notnull": "abc123",
- "null": "xyz789",
- "to": "xyz789"
+ "nin": ["xyz789"],
+ "notnull": "xyz789",
+ "null": "abc123",
+ "to": "abc123"
}
@@ -48945,7 +48044,7 @@ Description
Example
- 987.65
+ 123.45
@@ -49064,7 +48163,7 @@ Fields
Example
- {"template_id": 4}
+ {"template_id": "4"}
@@ -49193,8 +48292,8 @@ Fields
Example
{
"balance": Money,
- "code": "abc123",
- "expiration_date": "xyz789"
+ "code": "xyz789",
+ "expiration_date": "abc123"
}
@@ -49235,7 +48334,7 @@ Fields
Example
- {"gift_card_code": "xyz789"}
+ {"gift_card_code": "abc123"}
@@ -49301,12 +48400,12 @@ Fields
Example
{
- "attribute_id": 987,
+ "attribute_id": 123,
"uid": 4,
"value": 987.65,
"value_id": 987,
- "website_id": 123,
- "website_value": 123.45
+ "website_id": 987,
+ "website_value": 987.65
}
@@ -49466,22 +48565,22 @@ Example
"errors": [CartItemError],
"gift_message": GiftMessage,
"gift_wrapping": GiftWrapping,
- "id": "abc123",
- "is_available": true,
- "max_qty": 123.45,
- "message": "xyz789",
- "min_qty": 123.45,
- "not_available_message": "xyz789",
+ "id": "xyz789",
+ "is_available": false,
+ "max_qty": 987.65,
+ "message": "abc123",
+ "min_qty": 987.65,
+ "not_available_message": "abc123",
"note_from_buyer": [ItemNote],
"note_from_seller": [ItemNote],
"prices": CartItemPrices,
"product": ProductInterface,
- "quantity": 123.45,
- "recipient_email": "xyz789",
- "recipient_name": "abc123",
+ "quantity": 987.65,
+ "recipient_email": "abc123",
+ "recipient_name": "xyz789",
"sender_email": "xyz789",
- "sender_name": "xyz789",
- "uid": 4
+ "sender_name": "abc123",
+ "uid": "4"
}
@@ -49555,12 +48654,12 @@ Example
{
"discounts": [Discount],
"gift_card": GiftCardItem,
- "id": "4",
+ "id": 4,
"order_item": OrderItemInterface,
- "product_name": "abc123",
+ "product_name": "xyz789",
"product_sale_price": Money,
- "product_sku": "abc123",
- "quantity_refunded": 123.45
+ "product_sku": "xyz789",
+ "quantity_refunded": 987.65
}
@@ -49634,12 +48733,12 @@ Example
{
"discounts": [Discount],
"gift_card": GiftCardItem,
- "id": "4",
+ "id": 4,
"order_item": OrderItemInterface,
"product_name": "abc123",
"product_sale_price": Money,
"product_sku": "abc123",
- "quantity_invoiced": 123.45
+ "quantity_invoiced": 987.65
}
@@ -49700,9 +48799,9 @@ Fields
Example
{
- "message": "abc123",
+ "message": "xyz789",
"recipient_email": "xyz789",
- "recipient_name": "abc123",
+ "recipient_name": "xyz789",
"sender_email": "xyz789",
"sender_name": "abc123"
}
@@ -49778,7 +48877,7 @@ Example
"amount": Money,
"custom_giftcard_amount": Money,
"message": "abc123",
- "recipient_email": "abc123",
+ "recipient_email": "xyz789",
"recipient_name": "abc123",
"sender_email": "abc123",
"sender_name": "xyz789"
@@ -49929,7 +49028,7 @@ Fields
Example
{
"discounts": [Discount],
- "eligible_for_return": true,
+ "eligible_for_return": false,
"entered_options": [OrderItemOption],
"gift_card": GiftCardItem,
"gift_message": GiftMessage,
@@ -49939,18 +49038,18 @@ Example
"product": ProductInterface,
"product_name": "xyz789",
"product_sale_price": Money,
- "product_sku": "abc123",
- "product_type": "xyz789",
+ "product_sku": "xyz789",
+ "product_type": "abc123",
"product_url_key": "xyz789",
- "quantity_canceled": 123.45,
+ "quantity_canceled": 987.65,
"quantity_invoiced": 987.65,
- "quantity_ordered": 987.65,
- "quantity_refunded": 123.45,
+ "quantity_ordered": 123.45,
+ "quantity_refunded": 987.65,
"quantity_return_requested": 987.65,
- "quantity_returned": 987.65,
+ "quantity_returned": 123.45,
"quantity_shipped": 123.45,
"selected_options": [OrderItemOption],
- "status": "abc123"
+ "status": "xyz789"
}
@@ -50366,6 +49465,11 @@ currentPage
+
+ rules - [CatalogRule]
+
+ Provides applied catalog rules in the current active cart
+
sale - Int
@@ -50546,15 +49650,15 @@ currentPage
Example
{
- "activity": "xyz789",
- "allow_message": false,
- "allow_open_amount": false,
- "attribute_set_id": 123,
- "canonical_url": "xyz789",
+ "activity": "abc123",
+ "allow_message": true,
+ "allow_open_amount": true,
+ "attribute_set_id": 987,
+ "canonical_url": "abc123",
"categories": [CategoryInterface],
- "category_gear": "abc123",
+ "category_gear": "xyz789",
"climate": "abc123",
- "collar": "abc123",
+ "collar": "xyz789",
"color": 123,
"country_of_manufacture": "abc123",
"created_at": "xyz789",
@@ -50562,9 +49666,9 @@ Example
"custom_attributesV2": ProductCustomAttributes,
"description": ComplexTextValue,
"eco_collection": 123,
- "erin_recommends": 987,
- "features_bags": "abc123",
- "format": 123,
+ "erin_recommends": 123,
+ "features_bags": "xyz789",
+ "format": 987,
"gender": "abc123",
"gift_card_options": [CustomizableOptionInterface],
"gift_message_available": false,
@@ -50574,7 +49678,7 @@ Example
"giftcard_type": "VIRTUAL",
"id": 987,
"image": ProductImage,
- "is_redeemable": false,
+ "is_redeemable": true,
"is_returnable": "xyz789",
"lifetime": 987,
"manufacturer": 987,
@@ -50583,63 +49687,64 @@ Example
"media_gallery": [MediaGalleryInterface],
"media_gallery_entries": [MediaGalleryEntry],
"message_max_length": 123,
- "meta_description": "xyz789",
+ "meta_description": "abc123",
"meta_keyword": "xyz789",
"meta_title": "abc123",
- "min_sale_qty": 123.45,
+ "min_sale_qty": 987.65,
"name": "xyz789",
- "new": 123,
+ "new": 987,
"new_from_date": "xyz789",
- "new_to_date": "xyz789",
- "only_x_left_in_stock": 987.65,
- "open_amount_max": 987.65,
+ "new_to_date": "abc123",
+ "only_x_left_in_stock": 123.45,
+ "open_amount_max": 123.45,
"open_amount_min": 123.45,
"options": [CustomizableOptionInterface],
- "options_container": "abc123",
- "pattern": "xyz789",
- "performance_fabric": 987,
+ "options_container": "xyz789",
+ "pattern": "abc123",
+ "performance_fabric": 123,
"price": ProductPrices,
"price_range": PriceRange,
"price_tiers": [TierPrice],
"product_links": [ProductLinksInterface],
- "purpose": 123,
+ "purpose": 987,
"quantity": 123.45,
- "rating_summary": 987.65,
- "redirect_code": 123,
+ "rating_summary": 123.45,
+ "redirect_code": 987,
"related_products": [ProductInterface],
"relative_url": "abc123",
"review_count": 987,
"reviews": ProductReviews,
- "sale": 123,
+ "rules": [CatalogRule],
+ "sale": 987,
"short_description": ComplexTextValue,
"size": 123,
"sku": "xyz789",
"sleeve": "xyz789",
"small_image": ProductImage,
"special_from_date": "abc123",
- "special_price": 987.65,
- "special_to_date": "abc123",
- "staged": true,
+ "special_price": 123.45,
+ "special_to_date": "xyz789",
+ "staged": false,
"stock_status": "IN_STOCK",
"strap_bags": "xyz789",
- "style_bags": "abc123",
- "style_bottom": "abc123",
- "style_general": "abc123",
- "swatch_image": "xyz789",
+ "style_bags": "xyz789",
+ "style_bottom": "xyz789",
+ "style_general": "xyz789",
+ "swatch_image": "abc123",
"thumbnail": ProductImage,
- "tier_price": 123.45,
+ "tier_price": 987.65,
"tier_prices": [ProductTierPrices],
"type": "CMS_PAGE",
"type_id": "xyz789",
"uid": 4,
- "updated_at": "abc123",
+ "updated_at": "xyz789",
"upsell_products": [ProductInterface],
- "url_key": "abc123",
- "url_path": "xyz789",
+ "url_key": "xyz789",
+ "url_path": "abc123",
"url_rewrites": [UrlRewrite],
- "url_suffix": "xyz789",
+ "url_suffix": "abc123",
"websites": [Website],
- "weight": 123.45
+ "weight": 987.65
}
@@ -50703,8 +49808,8 @@ Example
"customizable_options": [SelectedCustomizableOption],
"gift_card_options": GiftCardOptions,
"product": ProductInterface,
- "quantity": 123.45,
- "uid": "4"
+ "quantity": 987.65,
+ "uid": 4
}
@@ -50772,9 +49877,9 @@ Fields
Example
{
"gift_card": GiftCardItem,
- "id": "4",
+ "id": 4,
"order_item": OrderItemInterface,
- "product_name": "abc123",
+ "product_name": "xyz789",
"product_sale_price": Money,
"product_sku": "xyz789",
"quantity_shipped": 123.45
@@ -50903,60 +50008,13 @@ Fields
Example
{
- "added_at": "abc123",
+ "added_at": "xyz789",
"customizable_options": [SelectedCustomizableOption],
- "description": "abc123",
+ "description": "xyz789",
"gift_card_options": GiftCardOptions,
"id": 4,
"product": ProductInterface,
- "quantity": 123.45
-}
-
-
-
-
-
-
-
- Types
-
- GiftCartAttributeValue
-
-
-
- Description
- Gift card custom attribute value containing array data.
-
-
-
-
-
- Example
- {
- "code": "4",
- "options": ["abc123"]
+ "quantity": 987.65
}
@@ -51007,9 +50065,9 @@ Fields
Example
{
- "from": "xyz789",
+ "from": "abc123",
"message": "abc123",
- "to": "abc123"
+ "to": "xyz789"
}
@@ -51064,8 +50122,8 @@ Fields
Example
{
"from": "abc123",
- "message": "xyz789",
- "to": "abc123"
+ "message": "abc123",
+ "to": "xyz789"
}
@@ -51232,7 +50290,7 @@ Fields
Example
{
- "created_at": "xyz789",
+ "created_at": "abc123",
"dynamic_attributes": [GiftRegistryDynamicAttribute],
"event_name": "abc123",
"items": [GiftRegistryItemInterface],
@@ -51243,7 +50301,7 @@ Example
"shipping_address": CustomerAddress,
"status": "ACTIVE",
"type": GiftRegistryType,
- "uid": 4
+ "uid": "4"
}
@@ -51295,10 +50353,10 @@ Fields
Example
{
- "code": 4,
+ "code": "4",
"group": "EVENT_INFORMATION",
"label": "xyz789",
- "value": "abc123"
+ "value": "xyz789"
}
@@ -51492,8 +50550,8 @@ Possible Types
Example
{
- "code": 4,
- "label": "abc123",
+ "code": "4",
+ "label": "xyz789",
"value": "abc123"
}
@@ -51556,9 +50614,9 @@ Fields
Example
{
- "attribute_group": "xyz789",
- "code": 4,
- "input_type": "xyz789",
+ "attribute_group": "abc123",
+ "code": "4",
+ "input_type": "abc123",
"is_required": false,
"label": "abc123",
"sort_order": 987
@@ -51640,12 +50698,12 @@ Possible Types
Example
{
- "attribute_group": "xyz789",
- "code": "4",
+ "attribute_group": "abc123",
+ "code": 4,
"input_type": "abc123",
"is_required": false,
"label": "abc123",
- "sort_order": 987
+ "sort_order": 123
}
@@ -51708,10 +50766,10 @@ Fields
Example
{
"created_at": "abc123",
- "note": "abc123",
+ "note": "xyz789",
"product": ProductInterface,
"quantity": 123.45,
- "quantity_fulfilled": 123.45,
+ "quantity_fulfilled": 987.65,
"uid": "4"
}
@@ -51791,12 +50849,12 @@ Possible Types
Example
{
- "created_at": "abc123",
- "note": "xyz789",
+ "created_at": "xyz789",
+ "note": "abc123",
"product": ProductInterface,
"quantity": 123.45,
"quantity_fulfilled": 123.45,
- "uid": 4
+ "uid": "4"
}
@@ -51923,7 +50981,7 @@ Example
{
"code": "OUT_OF_STOCK",
"gift_registry_item_uid": 4,
- "gift_registry_uid": 4,
+ "gift_registry_uid": "4",
"message": "xyz789",
"product_uid": 4
}
@@ -52146,9 +51204,9 @@ Example
GiftRegistryRegistrantDynamicAttribute
],
"email": "abc123",
- "firstname": "abc123",
+ "firstname": "xyz789",
"lastname": "xyz789",
- "uid": "4"
+ "uid": 4
}
@@ -52195,9 +51253,9 @@ Fields
Example
{
- "code": "4",
+ "code": 4,
"label": "abc123",
- "value": "xyz789"
+ "value": "abc123"
}
@@ -52263,12 +51321,12 @@ Fields
Example
{
- "event_date": "abc123",
- "event_title": "xyz789",
- "gift_registry_uid": 4,
- "location": "xyz789",
- "name": "xyz789",
- "type": "abc123"
+ "event_date": "xyz789",
+ "event_title": "abc123",
+ "gift_registry_uid": "4",
+ "location": "abc123",
+ "name": "abc123",
+ "type": "xyz789"
}
@@ -52308,12 +51366,6 @@ Fields
The ID assigned to this customer address.
-
-
- customer_address_uid - ID
-
- The unique ID assigned to this customer address.
-
Example
-{
- "address_data": CustomerAddressInput,
- "address_id": 4,
- "customer_address_uid": 4
-}
+ {"address_data": CustomerAddressInput, "address_id": 4}
Example
{
- "design": "xyz789",
- "id": "4",
+ "design": "abc123",
+ "id": 4,
"image": GiftWrappingImage,
"price": Money,
"uid": "4"
@@ -52539,8 +51587,8 @@ Fields
Example
{
- "label": "xyz789",
- "url": "xyz789"
+ "label": "abc123",
+ "url": "abc123"
}
@@ -52587,9 +51635,9 @@ Fields
Example
{
- "color": "abc123",
+ "color": "xyz789",
"height": 123,
- "type": "xyz789"
+ "type": "abc123"
}
@@ -52668,8 +51716,8 @@ Example
{
"button_styles": GooglePayButtonStyles,
"code": "abc123",
- "is_visible": true,
- "payment_intent": "abc123",
+ "is_visible": false,
+ "payment_intent": "xyz789",
"payment_source": "abc123",
"sdk_params": [SDKParams],
"sort_order": "xyz789",
@@ -52728,7 +51776,7 @@ Fields
Example
{
- "payment_source": "xyz789",
+ "payment_source": "abc123",
"payments_order_id": "xyz789",
"paypal_order_id": "xyz789"
}
@@ -53096,6 +52144,11 @@ currentPage
rules - [CatalogRule]
+ sale - Int
currentPage
Example
{
- "activity": "abc123",
- "attribute_set_id": 123,
- "canonical_url": "xyz789",
+ "activity": "xyz789",
+ "attribute_set_id": 987,
+ "canonical_url": "abc123",
"categories": [CategoryInterface],
- "category_gear": "xyz789",
- "climate": "abc123",
+ "category_gear": "abc123",
+ "climate": "xyz789",
"collar": "abc123",
"color": 987,
- "country_of_manufacture": "xyz789",
- "created_at": "abc123",
+ "country_of_manufacture": "abc123",
+ "created_at": "xyz789",
"crosssell_products": [ProductInterface],
"custom_attributesV2": ProductCustomAttributes,
"description": ComplexTextValue,
"eco_collection": 987,
"erin_recommends": 987,
- "features_bags": "xyz789",
+ "features_bags": "abc123",
"format": 123,
"gender": "xyz789",
- "gift_message_available": true,
+ "gift_message_available": false,
"gift_wrapping_available": false,
"gift_wrapping_price": Money,
"id": 987,
"image": ProductImage,
- "is_returnable": "abc123",
+ "is_returnable": "xyz789",
"items": [GroupedProductItem],
"manufacturer": 123,
"material": "xyz789",
- "max_sale_qty": 987.65,
+ "max_sale_qty": 123.45,
"media_gallery": [MediaGalleryInterface],
"media_gallery_entries": [MediaGalleryEntry],
- "meta_description": "abc123",
+ "meta_description": "xyz789",
"meta_keyword": "xyz789",
- "meta_title": "xyz789",
- "min_sale_qty": 987.65,
- "name": "abc123",
- "new": 123,
+ "meta_title": "abc123",
+ "min_sale_qty": 123.45,
+ "name": "xyz789",
+ "new": 987,
"new_from_date": "xyz789",
- "new_to_date": "xyz789",
- "only_x_left_in_stock": 123.45,
- "options_container": "xyz789",
+ "new_to_date": "abc123",
+ "only_x_left_in_stock": 987.65,
+ "options_container": "abc123",
"pattern": "abc123",
"performance_fabric": 987,
"price": ProductPrices,
"price_range": PriceRange,
"price_tiers": [TierPrice],
"product_links": [ProductLinksInterface],
- "purpose": 987,
- "quantity": 987.65,
+ "purpose": 123,
+ "quantity": 123.45,
"rating_summary": 987.65,
- "redirect_code": 123,
+ "redirect_code": 987,
"related_products": [ProductInterface],
"relative_url": "abc123",
- "review_count": 987,
+ "review_count": 123,
"reviews": ProductReviews,
- "sale": 987,
+ "rules": [CatalogRule],
+ "sale": 123,
"short_description": ComplexTextValue,
"size": 123,
"sku": "xyz789",
"sleeve": "abc123",
"small_image": ProductImage,
- "special_from_date": "xyz789",
- "special_price": 987.65,
- "special_to_date": "xyz789",
- "staged": false,
+ "special_from_date": "abc123",
+ "special_price": 123.45,
+ "special_to_date": "abc123",
+ "staged": true,
"stock_status": "IN_STOCK",
"strap_bags": "abc123",
"style_bags": "abc123",
"style_bottom": "abc123",
"style_general": "xyz789",
- "swatch_image": "xyz789",
+ "swatch_image": "abc123",
"thumbnail": ProductImage,
- "tier_price": 987.65,
+ "tier_price": 123.45,
"tier_prices": [ProductTierPrices],
"type": "CMS_PAGE",
- "type_id": "xyz789",
+ "type_id": "abc123",
"uid": 4,
- "updated_at": "xyz789",
+ "updated_at": "abc123",
"upsell_products": [ProductInterface],
"url_key": "xyz789",
"url_path": "abc123",
@@ -53478,10 +52532,10 @@ Fields
Example
{
- "added_at": "abc123",
+ "added_at": "xyz789",
"customizable_options": [SelectedCustomizableOption],
"description": "xyz789",
- "id": 4,
+ "id": "4",
"product": ProductInterface,
"quantity": 123.45
}
@@ -53531,64 +52585,8 @@ Fields
Example
{
- "reason": "abc123",
- "token": "xyz789"
-}
-
-
-
-
-
-
-
- Types
-
- GuestOrderInformationInput
-
-
-
- Description
- Input to retrieve an order based on details.
-
-
-
-
-
- Example
- {
- "email": "xyz789",
- "lastname": "xyz789",
- "number": "xyz789"
+ "reason": "xyz789",
+ "token": "abc123"
}
@@ -53681,18 +52679,18 @@ Fields
Example
{
- "cc_vault_code": "abc123",
- "code": "abc123",
+ "cc_vault_code": "xyz789",
+ "code": "xyz789",
"is_vault_enabled": true,
"is_visible": true,
- "payment_intent": "abc123",
+ "payment_intent": "xyz789",
"payment_source": "abc123",
- "requires_card_details": true,
+ "requires_card_details": false,
"sdk_params": [SDKParams],
"sort_order": "xyz789",
- "three_ds": true,
+ "three_ds": false,
"three_ds_mode": "OFF",
- "title": "abc123"
+ "title": "xyz789"
}
@@ -53782,15 +52780,15 @@ Fields
Example
{
- "cardBin": "abc123",
- "cardExpiryMonth": "xyz789",
- "cardExpiryYear": "xyz789",
+ "cardBin": "xyz789",
+ "cardExpiryMonth": "abc123",
+ "cardExpiryYear": "abc123",
"cardLast4": "xyz789",
- "holderName": "abc123",
- "is_active_payment_token_enabler": false,
- "payment_source": "abc123",
+ "holderName": "xyz789",
+ "is_active_payment_token_enabler": true,
+ "payment_source": "xyz789",
"payments_order_id": "xyz789",
- "paypal_order_id": "abc123"
+ "paypal_order_id": "xyz789"
}
@@ -53838,7 +52836,7 @@ Fields
Example
{
- "cancel_url": "xyz789",
+ "cancel_url": "abc123",
"return_url": "xyz789"
}
@@ -53964,7 +52962,7 @@ Fields
Example
{
- "name": "xyz789",
+ "name": "abc123",
"value": "xyz789"
}
@@ -53987,7 +52985,7 @@ Description
Example
- "4"
+ 4
@@ -54028,7 +53026,7 @@ Fields
Example
{
- "thumbnail": "abc123",
+ "thumbnail": "xyz789",
"value": "abc123"
}
@@ -54141,8 +53139,8 @@ Fields
Example
{
"code": "PRODUCT_NOT_FOUND",
- "message": "abc123",
- "quantity": 987.65
+ "message": "xyz789",
+ "quantity": 123.45
}
@@ -54266,7 +53264,7 @@ Example
"comments": [SalesCommentItem],
"id": 4,
"items": [InvoiceItemInterface],
- "number": "abc123",
+ "number": "xyz789",
"total": InvoiceTotal
}
@@ -54335,12 +53333,12 @@ Fields
Example
{
"discounts": [Discount],
- "id": "4",
+ "id": 4,
"order_item": OrderItemInterface,
- "product_name": "abc123",
+ "product_name": "xyz789",
"product_sale_price": Money,
"product_sku": "xyz789",
- "quantity_invoiced": 987.65
+ "quantity_invoiced": 123.45
}
@@ -54417,12 +53415,12 @@ Possible Types
-
+
-
+
@@ -54444,7 +53442,7 @@ Possible Types
Example
{
"discounts": [Discount],
- "id": 4,
+ "id": "4",
"order_item": OrderItemInterface,
"product_name": "abc123",
"product_sale_price": Money,
@@ -54572,7 +53570,7 @@ Fields
Example
- {"is_email_available": true}
+ {"is_email_available": false}
@@ -54611,7 +53609,7 @@ Fields
Example
- {"is_email_available": true}
+ {"is_email_available": false}
@@ -54650,7 +53648,7 @@ Fields
Example
- {"is_role_name_available": true}
+ {"is_role_name_available": false}
@@ -54689,7 +53687,7 @@ Fields
Example
- {"is_email_available": true}
+ {"is_email_available": false}
@@ -54728,7 +53726,7 @@ Fields
Example
- {"is_email_available": true}
+ {"is_email_available": false}
@@ -54793,12 +53791,12 @@ Fields
Example
{
- "created_at": "xyz789",
+ "created_at": "abc123",
"creator_id": 123,
- "creator_type": 987,
- "negotiable_quote_item_uid": 4,
+ "creator_type": 123,
+ "negotiable_quote_item_uid": "4",
"note": "abc123",
- "note_uid": 4
+ "note_uid": "4"
}
@@ -54929,7 +53927,7 @@ Example
"price": Money,
"product_name": "abc123",
"product_sku": "abc123",
- "quantity": 987.65,
+ "quantity": 123.45,
"uid": "4"
}
@@ -55091,7 +54089,7 @@ Fields
Example
{
"items_count": 123,
- "label": "abc123",
+ "label": "xyz789",
"value_string": "abc123"
}
@@ -55164,9 +54162,9 @@ Possible Types
Example
{
- "items_count": 123,
+ "items_count": 987,
"label": "xyz789",
- "value_string": "xyz789"
+ "value_string": "abc123"
}
@@ -55220,9 +54218,9 @@ Fields
Example
{
- "note": "abc123",
+ "note": "xyz789",
"quote_item_uid": "4",
- "quote_uid": 4
+ "quote_uid": "4"
}
@@ -55315,9 +54313,9 @@ Example
"id": 123,
"label": "abc123",
"media_type": "xyz789",
- "position": 123,
- "types": ["abc123"],
- "uid": "4",
+ "position": 987,
+ "types": ["xyz789"],
+ "uid": 4,
"video_content": ProductMediaGalleryEntriesVideoContent
}
@@ -55361,11 +54359,6 @@ Fields
The media item's position after it has been sorted.
-
- types - [String]
-
- Array of image types. It can have the following values: image, small_image, thumbnail.
-
url - String
@@ -55402,10 +54395,9 @@ Possible Types
Example
{
"disabled": true,
- "label": "abc123",
+ "label": "xyz789",
"position": 123,
- "types": ["abc123"],
- "url": "abc123"
+ "url": "xyz789"
}
@@ -55482,7 +54474,7 @@ Fields
Example
{
- "layout": "abc123",
+ "layout": "xyz789",
"logo": MessageStyleLogo
}
@@ -55528,7 +54520,7 @@ Fields
Example
- {"currency": "AFN", "value": 987.65}
+ {"currency": "AFN", "value": 123.45}
@@ -55579,7 +54571,7 @@ Fields
Example
{
"gift_registry": GiftRegistry,
- "status": true,
+ "status": false,
"user_errors": [GiftRegistryItemsUserError]
}
@@ -55621,7 +54613,7 @@ Fields
Example
- {"requisitionListItemUids": [4]}
+ {"requisitionListItemUids": ["4"]}
@@ -55721,7 +54713,7 @@ Fields
Example
{
- "quote_item_uid": "4",
+ "quote_item_uid": 4,
"quote_uid": "4",
"requisition_list_uid": "4"
}
@@ -55940,10 +54932,10 @@ Example
"billing_address": NegotiableQuoteBillingAddress,
"buyer": NegotiableQuoteUser,
"comments": [NegotiableQuoteComment],
- "created_at": "abc123",
+ "created_at": "xyz789",
"email": "abc123",
"history": [NegotiableQuoteHistoryEntry],
- "is_virtual": false,
+ "is_virtual": true,
"items": [CartItemInterface],
"name": "abc123",
"prices": CartPrices,
@@ -55951,8 +54943,8 @@ Example
"shipping_addresses": [NegotiableQuoteShippingAddress],
"status": "SUBMITTED",
"total_quantity": 123.45,
- "uid": 4,
- "updated_at": "xyz789"
+ "uid": "4",
+ "updated_at": "abc123"
}
@@ -55998,8 +54990,8 @@ Fields
Example
{
- "code": "abc123",
- "label": "xyz789"
+ "code": "xyz789",
+ "label": "abc123"
}
@@ -56101,15 +55093,15 @@ Fields
Example
{
- "city": "abc123",
+ "city": "xyz789",
"company": "abc123",
"country_code": "abc123",
"firstname": "xyz789",
"lastname": "xyz789",
"postcode": "xyz789",
"region": "xyz789",
- "region_id": 123,
- "save_in_address_book": true,
+ "region_id": 987,
+ "save_in_address_book": false,
"street": ["abc123"],
"telephone": "xyz789"
}
@@ -56210,12 +55202,12 @@ Possible Types
Example
{
- "city": "abc123",
- "company": "abc123",
+ "city": "xyz789",
+ "company": "xyz789",
"country": NegotiableQuoteAddressCountry,
- "firstname": "xyz789",
+ "firstname": "abc123",
"lastname": "abc123",
- "postcode": "xyz789",
+ "postcode": "abc123",
"region": NegotiableQuoteAddressRegion,
"street": ["xyz789"],
"telephone": "abc123"
@@ -56269,9 +55261,9 @@ Fields
Example
{
- "code": "xyz789",
+ "code": "abc123",
"label": "abc123",
- "region_id": 123
+ "region_id": 987
}
@@ -56348,14 +55340,14 @@ Fields
Example
{
- "city": "xyz789",
- "company": "xyz789",
+ "city": "abc123",
+ "company": "abc123",
"country": NegotiableQuoteAddressCountry,
"firstname": "abc123",
"lastname": "xyz789",
"postcode": "abc123",
"region": NegotiableQuoteAddressRegion,
- "street": ["abc123"],
+ "street": ["xyz789"],
"telephone": "abc123"
}
@@ -56419,7 +55411,7 @@ Example
"address": NegotiableQuoteAddressInput,
"customer_address_uid": 4,
"same_as_shipping": true,
- "use_for_shipping": true
+ "use_for_shipping": false
}
@@ -56483,7 +55475,7 @@ Example
"author": NegotiableQuoteUser,
"created_at": "xyz789",
"creator_type": "BUYER",
- "text": "xyz789",
+ "text": "abc123",
"uid": 4
}
@@ -56569,7 +55561,7 @@ Fields
Example
- {"comment": "abc123"}
+ {"comment": "xyz789"}
@@ -56621,7 +55613,7 @@ Example
{
"new_value": "xyz789",
"old_value": "xyz789",
- "title": "xyz789"
+ "title": "abc123"
}
@@ -56844,7 +55836,7 @@ Example
"author": NegotiableQuoteUser,
"change_type": "CREATED",
"changes": NegotiableQuoteHistoryChanges,
- "created_at": "abc123",
+ "created_at": "xyz789",
"uid": "4"
}
@@ -56950,7 +55942,7 @@ Fields
Example
{
"new_expiration": "xyz789",
- "old_expiration": "xyz789"
+ "old_expiration": "abc123"
}
@@ -57167,7 +56159,7 @@ Fields
Example
- {"message": "abc123"}
+ {"message": "xyz789"}
@@ -57213,7 +56205,7 @@ Fields
Example
- {"quantity": 123.45, "quote_item_uid": 4}
+ {"quantity": 987.65, "quote_item_uid": 4}
@@ -57319,7 +56311,7 @@ Example
{
"document_identifier": "xyz789",
"document_name": "abc123",
- "link_id": "4",
+ "link_id": 4,
"reference_document_url": "abc123"
}
@@ -57408,12 +56400,12 @@ Fields
Example
{
"available_shipping_methods": [AvailableShippingMethod],
- "city": "abc123",
+ "city": "xyz789",
"company": "abc123",
"country": NegotiableQuoteAddressCountry,
- "firstname": "abc123",
+ "firstname": "xyz789",
"lastname": "abc123",
- "postcode": "abc123",
+ "postcode": "xyz789",
"region": NegotiableQuoteAddressRegion,
"selected_shipping_method": SelectedShippingMethod,
"street": ["abc123"],
@@ -57789,7 +56781,7 @@ Example
"is_virtual": false,
"items": [CartItemInterface],
"max_order_commitment": 123,
- "min_order_commitment": 123,
+ "min_order_commitment": 987,
"name": "xyz789",
"notifications": [QuoteTemplateNotificationMessage],
"prices": CartPrices,
@@ -57798,7 +56790,7 @@ Example
],
"shipping_addresses": [NegotiableQuoteShippingAddress],
"status": "abc123",
- "template_id": 4,
+ "template_id": "4",
"total_quantity": 123.45
}
@@ -57962,14 +56954,14 @@ Example
"activated_at": "abc123",
"company_name": "xyz789",
"expiration_date": "abc123",
- "is_min_max_qty_used": true,
+ "is_min_max_qty_used": false,
"last_shared_at": "xyz789",
"max_order_commitment": 123,
- "min_negotiated_grand_total": 123.45,
+ "min_negotiated_grand_total": 987.65,
"min_order_commitment": 123,
"name": "xyz789",
- "orders_placed": 987,
- "sales_rep_name": "abc123",
+ "orders_placed": 123,
+ "sales_rep_name": "xyz789",
"state": "xyz789",
"status": "abc123",
"submitted_by": "abc123",
@@ -58032,7 +57024,12 @@ Fields
Example
- {"item_id": 4, "max_qty": 987.65, "min_qty": 987.65, "quantity": 987.65}
+ {
+ "item_id": "4",
+ "max_qty": 123.45,
+ "min_qty": 987.65,
+ "quantity": 987.65
+}
@@ -58092,9 +57089,9 @@ Fields
Example
{
"document_identifier": "xyz789",
- "document_name": "xyz789",
- "link_id": 4,
- "reference_document_url": "xyz789"
+ "document_name": "abc123",
+ "link_id": "4",
+ "reference_document_url": "abc123"
}
@@ -58150,7 +57147,7 @@ Example
{
"address": NegotiableQuoteAddressInput,
"customer_address_uid": 4,
- "customer_notes": "xyz789"
+ "customer_notes": "abc123"
}
@@ -58297,7 +57294,7 @@ Example
"items": [NegotiableQuoteTemplateGridItem],
"page_info": SearchResultPageInfo,
"sort_fields": SortFields,
- "total_count": 987
+ "total_count": 123
}
@@ -58350,7 +57347,7 @@ Possible Types
Example
- {"quote_uid": 4}
+ {"quote_uid": "4"}
@@ -58389,7 +57386,7 @@ Fields
Example
- {"quote_uid": 4}
+ {"quote_uid": "4"}
@@ -58435,7 +57432,7 @@ Fields
Example
{
"firstname": "xyz789",
- "lastname": "abc123"
+ "lastname": "xyz789"
}
@@ -58494,7 +57491,7 @@ Example
"items": [NegotiableQuote],
"page_info": SearchResultPageInfo,
"sort_fields": SortFields,
- "total_count": 123
+ "total_count": 987
}
@@ -58540,7 +57537,7 @@ Fields
Example
{
- "message": "abc123",
+ "message": "xyz789",
"uid": "4"
}
@@ -58582,7 +57579,7 @@ Fields
Example
- {"template_id": 4}
+ {"template_id": "4"}
@@ -58630,7 +57627,7 @@ Fields
Example
{
"order_id": "abc123",
- "order_number": "xyz789"
+ "order_number": "abc123"
}
@@ -58815,21 +57812,21 @@ attributeCodes
Example
{
"city": "abc123",
- "company": "abc123",
+ "company": "xyz789",
"country_code": "AF",
"custom_attributesV2": [AttributeValueInterface],
- "fax": "abc123",
- "firstname": "abc123",
+ "fax": "xyz789",
+ "firstname": "xyz789",
"lastname": "abc123",
- "middlename": "abc123",
+ "middlename": "xyz789",
"postcode": "xyz789",
"prefix": "xyz789",
- "region": "abc123",
- "region_id": 4,
- "street": ["xyz789"],
+ "region": "xyz789",
+ "region_id": "4",
+ "street": ["abc123"],
"suffix": "abc123",
"telephone": "xyz789",
- "vat_id": "xyz789"
+ "vat_id": "abc123"
}
@@ -58886,12 +57883,68 @@ Fields
Example
{
- "firstname": "abc123",
+ "firstname": "xyz789",
"lastname": "abc123",
- "middlename": "abc123",
- "prefix": "xyz789",
+ "middlename": "xyz789",
+ "prefix": "abc123",
"suffix": "xyz789"
}
+
+
+
+
+
+
+
+ Types
+
+ OrderInformationInput
+
+
+
+ Description
+ Input to retrieve an order based on details.
+
+
+
+
+
+ Example
+ {
+ "email": "xyz789",
+ "lastname": "abc123",
+ "number": "xyz789"
+}
@@ -59033,7 +58086,7 @@ Fields
Example
{
"discounts": [Discount],
- "eligible_for_return": true,
+ "eligible_for_return": false,
"entered_options": [OrderItemOption],
"gift_message": GiftMessage,
"gift_wrapping": GiftWrapping,
@@ -59044,16 +58097,16 @@ Example
"product_sale_price": Money,
"product_sku": "xyz789",
"product_type": "abc123",
- "product_url_key": "abc123",
+ "product_url_key": "xyz789",
"quantity_canceled": 123.45,
"quantity_invoiced": 123.45,
- "quantity_ordered": 987.65,
+ "quantity_ordered": 123.45,
"quantity_refunded": 123.45,
"quantity_return_requested": 987.65,
- "quantity_returned": 987.65,
- "quantity_shipped": 123.45,
+ "quantity_returned": 123.45,
+ "quantity_shipped": 987.65,
"selected_options": [OrderItemOption],
- "status": "abc123"
+ "status": "xyz789"
}
@@ -59210,12 +58263,12 @@ Possible Types
-
+
-
+
@@ -59237,7 +58290,7 @@ Possible Types
Example
{
"discounts": [Discount],
- "eligible_for_return": true,
+ "eligible_for_return": false,
"entered_options": [OrderItemOption],
"gift_message": GiftMessage,
"gift_wrapping": GiftWrapping,
@@ -59246,18 +58299,18 @@ Example
"product": ProductInterface,
"product_name": "abc123",
"product_sale_price": Money,
- "product_sku": "xyz789",
+ "product_sku": "abc123",
"product_type": "xyz789",
- "product_url_key": "xyz789",
+ "product_url_key": "abc123",
"quantity_canceled": 123.45,
"quantity_invoiced": 987.65,
"quantity_ordered": 123.45,
- "quantity_refunded": 123.45,
- "quantity_return_requested": 987.65,
+ "quantity_refunded": 987.65,
+ "quantity_return_requested": 123.45,
"quantity_returned": 987.65,
- "quantity_shipped": 123.45,
+ "quantity_shipped": 987.65,
"selected_options": [OrderItemOption],
- "status": "xyz789"
+ "status": "abc123"
}
@@ -59303,8 +58356,8 @@ Fields
Example
{
- "label": "xyz789",
- "value": "abc123"
+ "label": "abc123",
+ "value": "xyz789"
}
@@ -59454,7 +58507,7 @@ Fields
Example
{
"additional_data": [KeyValue],
- "name": "xyz789",
+ "name": "abc123",
"type": "abc123"
}
@@ -59519,7 +58572,7 @@ Example
"comments": [SalesCommentItem],
"id": "4",
"items": [ShipmentItemInterface],
- "number": "xyz789",
+ "number": "abc123",
"tracking": [ShipmentTracking]
}
@@ -59561,7 +58614,7 @@ Fields
Example
- {"token": "xyz789"}
+ {"token": "abc123"}
@@ -59609,11 +58662,6 @@ Fields
The final total amount, including shipping, discounts, and taxes.
-
- grand_total_excl_tax - Money!
-
- The grand total of the order, excluding taxes.
-
shipping_handling - ShippingHandling
@@ -59677,7 +58725,6 @@ Example
"discounts": [Discount],
"gift_options": GiftOptionsPrices,
"grand_total": Money,
- "grand_total_excl_tax": Money,
"shipping_handling": ShippingHandling,
"subtotal": Money,
"subtotal_excl_tax": Money,
@@ -59735,8 +58782,8 @@ Fields
Example
{
- "payer_id": "xyz789",
- "token": "xyz789"
+ "payer_id": "abc123",
+ "token": "abc123"
}
@@ -59791,8 +58838,8 @@ Fields
Example
{
"cancel_url": "xyz789",
- "error_url": "abc123",
- "return_url": "xyz789"
+ "error_url": "xyz789",
+ "return_url": "abc123"
}
@@ -59897,9 +58944,9 @@ Fields
Example
{
"mode": "TEST",
- "paypal_url": "abc123",
- "secure_token": "xyz789",
- "secure_token_id": "xyz789"
+ "paypal_url": "xyz789",
+ "secure_token": "abc123",
+ "secure_token_id": "abc123"
}
@@ -59940,7 +58987,7 @@ Fields
Example
- {"cart_id": "xyz789"}
+ {"cart_id": "abc123"}
@@ -60036,7 +59083,7 @@ Fields
Example
{
- "cart_id": "xyz789",
+ "cart_id": "abc123",
"paypal_payload": "abc123"
}
@@ -60120,7 +59167,7 @@ Fields
Example
{
- "cart_id": "abc123",
+ "cart_id": "xyz789",
"urls": PayflowProUrlInput
}
@@ -60175,9 +59222,9 @@ Fields
Example
{
- "cancel_url": "xyz789",
+ "cancel_url": "abc123",
"error_url": "xyz789",
- "return_url": "abc123"
+ "return_url": "xyz789"
}
@@ -60267,11 +59314,6 @@ Possible Types
-
-
-
-
-
@@ -60280,12 +59322,12 @@ Possible Types
Example
{
- "code": "abc123",
- "is_visible": true,
+ "code": "xyz789",
+ "is_visible": false,
"payment_intent": "xyz789",
"sdk_params": [SDKParams],
- "sort_order": "abc123",
- "title": "abc123"
+ "sort_order": "xyz789",
+ "title": "xyz789"
}
@@ -60318,11 +59360,6 @@ Fields
ApplePay payment method configuration
Example
{
- "activity": "abc123",
- "attribute_set_id": 123,
- "canonical_url": "xyz789",
+ "activity": "xyz789",
+ "attribute_set_id": 987,
+ "canonical_url": "abc123",
"categories": [CategoryInterface],
- "category_gear": "xyz789",
- "climate": "abc123",
+ "category_gear": "abc123",
+ "climate": "xyz789",
"collar": "abc123",
"color": 987,
- "country_of_manufacture": "xyz789",
- "created_at": "abc123",
+ "country_of_manufacture": "abc123",
+ "created_at": "xyz789",
"crosssell_products": [ProductInterface],
"custom_attributesV2": ProductCustomAttributes,
"description": ComplexTextValue,
"eco_collection": 987,
"erin_recommends": 987,
- "features_bags": "xyz789",
+ "features_bags": "abc123",
"format": 123,
"gender": "xyz789",
- "gift_message_available": true,
+ "gift_message_available": false,
"gift_wrapping_available": false,
"gift_wrapping_price": Money,
"id": 987,
"image": ProductImage,
- "is_returnable": "abc123",
+ "is_returnable": "xyz789",
"items": [GroupedProductItem],
"manufacturer": 123,
"material": "xyz789",
- "max_sale_qty": 987.65,
+ "max_sale_qty": 123.45,
"media_gallery": [MediaGalleryInterface],
"media_gallery_entries": [MediaGalleryEntry],
- "meta_description": "abc123",
+ "meta_description": "xyz789",
"meta_keyword": "xyz789",
- "meta_title": "xyz789",
- "min_sale_qty": 987.65,
- "name": "abc123",
- "new": 123,
+ "meta_title": "abc123",
+ "min_sale_qty": 123.45,
+ "name": "xyz789",
+ "new": 987,
"new_from_date": "xyz789",
- "new_to_date": "xyz789",
- "only_x_left_in_stock": 123.45,
- "options_container": "xyz789",
+ "new_to_date": "abc123",
+ "only_x_left_in_stock": 987.65,
+ "options_container": "abc123",
"pattern": "abc123",
"performance_fabric": 987,
"price": ProductPrices,
"price_range": PriceRange,
"price_tiers": [TierPrice],
"product_links": [ProductLinksInterface],
- "purpose": 987,
- "quantity": 987.65,
+ "purpose": 123,
+ "quantity": 123.45,
"rating_summary": 987.65,
- "redirect_code": 123,
+ "redirect_code": 987,
"related_products": [ProductInterface],
"relative_url": "abc123",
- "review_count": 987,
+ "review_count": 123,
"reviews": ProductReviews,
- "sale": 987,
+ "rules": [CatalogRule],
+ "sale": 123,
"short_description": ComplexTextValue,
"size": 123,
"sku": "xyz789",
"sleeve": "abc123",
"small_image": ProductImage,
- "special_from_date": "xyz789",
- "special_price": 987.65,
- "special_to_date": "xyz789",
- "staged": false,
+ "special_from_date": "abc123",
+ "special_price": 123.45,
+ "special_to_date": "abc123",
+ "staged": true,
"stock_status": "IN_STOCK",
"strap_bags": "abc123",
"style_bags": "abc123",
"style_bottom": "abc123",
"style_general": "xyz789",
- "swatch_image": "xyz789",
+ "swatch_image": "abc123",
"thumbnail": ProductImage,
- "tier_price": 987.65,
+ "tier_price": 123.45,
"tier_prices": [ProductTierPrices],
"type": "CMS_PAGE",
- "type_id": "xyz789",
+ "type_id": "abc123",
"uid": 4,
- "updated_at": "xyz789",
+ "updated_at": "abc123",
"upsell_products": [ProductInterface],
"url_key": "xyz789",
"url_path": "abc123",
@@ -53478,10 +52532,10 @@ Fields
Example
{
- "added_at": "abc123",
+ "added_at": "xyz789",
"customizable_options": [SelectedCustomizableOption],
"description": "xyz789",
- "id": 4,
+ "id": "4",
"product": ProductInterface,
"quantity": 123.45
}
@@ -53531,64 +52585,8 @@ Fields
Example
{
- "reason": "abc123",
- "token": "xyz789"
-}
-
-
-
-
-
-
-
- Types
-
- GuestOrderInformationInput
-
-
-
- Description
- Input to retrieve an order based on details.
-
-
-
-
-
- Example
- {
- "email": "xyz789",
- "lastname": "xyz789",
- "number": "xyz789"
+ "reason": "xyz789",
+ "token": "abc123"
}
@@ -53681,18 +52679,18 @@ Fields
Example
{
- "cc_vault_code": "abc123",
- "code": "abc123",
+ "cc_vault_code": "xyz789",
+ "code": "xyz789",
"is_vault_enabled": true,
"is_visible": true,
- "payment_intent": "abc123",
+ "payment_intent": "xyz789",
"payment_source": "abc123",
- "requires_card_details": true,
+ "requires_card_details": false,
"sdk_params": [SDKParams],
"sort_order": "xyz789",
- "three_ds": true,
+ "three_ds": false,
"three_ds_mode": "OFF",
- "title": "abc123"
+ "title": "xyz789"
}
@@ -53782,15 +52780,15 @@ Fields
Example
{
- "cardBin": "abc123",
- "cardExpiryMonth": "xyz789",
- "cardExpiryYear": "xyz789",
+ "cardBin": "xyz789",
+ "cardExpiryMonth": "abc123",
+ "cardExpiryYear": "abc123",
"cardLast4": "xyz789",
- "holderName": "abc123",
- "is_active_payment_token_enabler": false,
- "payment_source": "abc123",
+ "holderName": "xyz789",
+ "is_active_payment_token_enabler": true,
+ "payment_source": "xyz789",
"payments_order_id": "xyz789",
- "paypal_order_id": "abc123"
+ "paypal_order_id": "xyz789"
}
@@ -53838,7 +52836,7 @@ Fields
Example
{
- "cancel_url": "xyz789",
+ "cancel_url": "abc123",
"return_url": "xyz789"
}
@@ -53964,7 +52962,7 @@ Fields
Example
{
- "name": "xyz789",
+ "name": "abc123",
"value": "xyz789"
}
@@ -53987,7 +52985,7 @@ Description
Example
- "4"
+ 4
@@ -54028,7 +53026,7 @@ Fields
Example
{
- "thumbnail": "abc123",
+ "thumbnail": "xyz789",
"value": "abc123"
}
@@ -54141,8 +53139,8 @@ Fields
Example
{
"code": "PRODUCT_NOT_FOUND",
- "message": "abc123",
- "quantity": 987.65
+ "message": "xyz789",
+ "quantity": 123.45
}
@@ -54266,7 +53264,7 @@ Example
"comments": [SalesCommentItem],
"id": 4,
"items": [InvoiceItemInterface],
- "number": "abc123",
+ "number": "xyz789",
"total": InvoiceTotal
}
@@ -54335,12 +53333,12 @@ Fields
Example
{
"discounts": [Discount],
- "id": "4",
+ "id": 4,
"order_item": OrderItemInterface,
- "product_name": "abc123",
+ "product_name": "xyz789",
"product_sale_price": Money,
"product_sku": "xyz789",
- "quantity_invoiced": 987.65
+ "quantity_invoiced": 123.45
}
@@ -54417,12 +53415,12 @@ Possible Types
-
+
-
+
@@ -54444,7 +53442,7 @@ Possible Types
Example
{
"discounts": [Discount],
- "id": 4,
+ "id": "4",
"order_item": OrderItemInterface,
"product_name": "abc123",
"product_sale_price": Money,
@@ -54572,7 +53570,7 @@ Fields
Example
- {"is_email_available": true}
+ {"is_email_available": false}
@@ -54611,7 +53609,7 @@ Fields
Example
- {"is_email_available": true}
+ {"is_email_available": false}
@@ -54650,7 +53648,7 @@ Fields
Example
- {"is_role_name_available": true}
+ {"is_role_name_available": false}
@@ -54689,7 +53687,7 @@ Fields
Example
- {"is_email_available": true}
+ {"is_email_available": false}
@@ -54728,7 +53726,7 @@ Fields
Example
- {"is_email_available": true}
+ {"is_email_available": false}
@@ -54793,12 +53791,12 @@ Fields
Example
{
- "created_at": "xyz789",
+ "created_at": "abc123",
"creator_id": 123,
- "creator_type": 987,
- "negotiable_quote_item_uid": 4,
+ "creator_type": 123,
+ "negotiable_quote_item_uid": "4",
"note": "abc123",
- "note_uid": 4
+ "note_uid": "4"
}
@@ -54929,7 +53927,7 @@ Example
"price": Money,
"product_name": "abc123",
"product_sku": "abc123",
- "quantity": 987.65,
+ "quantity": 123.45,
"uid": "4"
}
@@ -55091,7 +54089,7 @@ Fields
Example
{
"items_count": 123,
- "label": "abc123",
+ "label": "xyz789",
"value_string": "abc123"
}
@@ -55164,9 +54162,9 @@ Possible Types
Example
{
- "items_count": 123,
+ "items_count": 987,
"label": "xyz789",
- "value_string": "xyz789"
+ "value_string": "abc123"
}
@@ -55220,9 +54218,9 @@ Fields
Example
{
- "note": "abc123",
+ "note": "xyz789",
"quote_item_uid": "4",
- "quote_uid": 4
+ "quote_uid": "4"
}
@@ -55315,9 +54313,9 @@ Example
"id": 123,
"label": "abc123",
"media_type": "xyz789",
- "position": 123,
- "types": ["abc123"],
- "uid": "4",
+ "position": 987,
+ "types": ["xyz789"],
+ "uid": 4,
"video_content": ProductMediaGalleryEntriesVideoContent
}
@@ -55361,11 +54359,6 @@ Fields
The media item's position after it has been sorted.
-
- types - [String]
-
- Array of image types. It can have the following values: image, small_image, thumbnail.
-
url - String
@@ -55402,10 +54395,9 @@ Possible Types
Example
{
"disabled": true,
- "label": "abc123",
+ "label": "xyz789",
"position": 123,
- "types": ["abc123"],
- "url": "abc123"
+ "url": "xyz789"
}
@@ -55482,7 +54474,7 @@ Fields
Example
{
- "layout": "abc123",
+ "layout": "xyz789",
"logo": MessageStyleLogo
}
@@ -55528,7 +54520,7 @@ Fields
Example
- {"currency": "AFN", "value": 987.65}
+ {"currency": "AFN", "value": 123.45}
@@ -55579,7 +54571,7 @@ Fields
Example
{
"gift_registry": GiftRegistry,
- "status": true,
+ "status": false,
"user_errors": [GiftRegistryItemsUserError]
}
@@ -55621,7 +54613,7 @@ Fields
Example
- {"requisitionListItemUids": [4]}
+ {"requisitionListItemUids": ["4"]}
@@ -55721,7 +54713,7 @@ Fields
Example
{
- "quote_item_uid": "4",
+ "quote_item_uid": 4,
"quote_uid": "4",
"requisition_list_uid": "4"
}
@@ -55940,10 +54932,10 @@ Example
"billing_address": NegotiableQuoteBillingAddress,
"buyer": NegotiableQuoteUser,
"comments": [NegotiableQuoteComment],
- "created_at": "abc123",
+ "created_at": "xyz789",
"email": "abc123",
"history": [NegotiableQuoteHistoryEntry],
- "is_virtual": false,
+ "is_virtual": true,
"items": [CartItemInterface],
"name": "abc123",
"prices": CartPrices,
@@ -55951,8 +54943,8 @@ Example
"shipping_addresses": [NegotiableQuoteShippingAddress],
"status": "SUBMITTED",
"total_quantity": 123.45,
- "uid": 4,
- "updated_at": "xyz789"
+ "uid": "4",
+ "updated_at": "abc123"
}
@@ -55998,8 +54990,8 @@ Fields
Example
{
- "code": "abc123",
- "label": "xyz789"
+ "code": "xyz789",
+ "label": "abc123"
}
@@ -56101,15 +55093,15 @@ Fields
Example
{
- "city": "abc123",
+ "city": "xyz789",
"company": "abc123",
"country_code": "abc123",
"firstname": "xyz789",
"lastname": "xyz789",
"postcode": "xyz789",
"region": "xyz789",
- "region_id": 123,
- "save_in_address_book": true,
+ "region_id": 987,
+ "save_in_address_book": false,
"street": ["abc123"],
"telephone": "xyz789"
}
@@ -56210,12 +55202,12 @@ Possible Types
Example
{
- "city": "abc123",
- "company": "abc123",
+ "city": "xyz789",
+ "company": "xyz789",
"country": NegotiableQuoteAddressCountry,
- "firstname": "xyz789",
+ "firstname": "abc123",
"lastname": "abc123",
- "postcode": "xyz789",
+ "postcode": "abc123",
"region": NegotiableQuoteAddressRegion,
"street": ["xyz789"],
"telephone": "abc123"
@@ -56269,9 +55261,9 @@ Fields
Example
{
- "code": "xyz789",
+ "code": "abc123",
"label": "abc123",
- "region_id": 123
+ "region_id": 987
}
@@ -56348,14 +55340,14 @@ Fields
Example
{
- "city": "xyz789",
- "company": "xyz789",
+ "city": "abc123",
+ "company": "abc123",
"country": NegotiableQuoteAddressCountry,
"firstname": "abc123",
"lastname": "xyz789",
"postcode": "abc123",
"region": NegotiableQuoteAddressRegion,
- "street": ["abc123"],
+ "street": ["xyz789"],
"telephone": "abc123"
}
@@ -56419,7 +55411,7 @@ Example
"address": NegotiableQuoteAddressInput,
"customer_address_uid": 4,
"same_as_shipping": true,
- "use_for_shipping": true
+ "use_for_shipping": false
}
@@ -56483,7 +55475,7 @@ Example
"author": NegotiableQuoteUser,
"created_at": "xyz789",
"creator_type": "BUYER",
- "text": "xyz789",
+ "text": "abc123",
"uid": 4
}
@@ -56569,7 +55561,7 @@ Fields
Example
- {"comment": "abc123"}
+ {"comment": "xyz789"}
@@ -56621,7 +55613,7 @@ Example
{
"new_value": "xyz789",
"old_value": "xyz789",
- "title": "xyz789"
+ "title": "abc123"
}
@@ -56844,7 +55836,7 @@ Example
"author": NegotiableQuoteUser,
"change_type": "CREATED",
"changes": NegotiableQuoteHistoryChanges,
- "created_at": "abc123",
+ "created_at": "xyz789",
"uid": "4"
}
@@ -56950,7 +55942,7 @@ Fields
Example
{
"new_expiration": "xyz789",
- "old_expiration": "xyz789"
+ "old_expiration": "abc123"
}
@@ -57167,7 +56159,7 @@ Fields
Example
- {"message": "abc123"}
+ {"message": "xyz789"}
@@ -57213,7 +56205,7 @@ Fields
Example
- {"quantity": 123.45, "quote_item_uid": 4}
+ {"quantity": 987.65, "quote_item_uid": 4}
@@ -57319,7 +56311,7 @@ Example
{
"document_identifier": "xyz789",
"document_name": "abc123",
- "link_id": "4",
+ "link_id": 4,
"reference_document_url": "abc123"
}
@@ -57408,12 +56400,12 @@ Fields
Example
{
"available_shipping_methods": [AvailableShippingMethod],
- "city": "abc123",
+ "city": "xyz789",
"company": "abc123",
"country": NegotiableQuoteAddressCountry,
- "firstname": "abc123",
+ "firstname": "xyz789",
"lastname": "abc123",
- "postcode": "abc123",
+ "postcode": "xyz789",
"region": NegotiableQuoteAddressRegion,
"selected_shipping_method": SelectedShippingMethod,
"street": ["abc123"],
@@ -57789,7 +56781,7 @@ Example
"is_virtual": false,
"items": [CartItemInterface],
"max_order_commitment": 123,
- "min_order_commitment": 123,
+ "min_order_commitment": 987,
"name": "xyz789",
"notifications": [QuoteTemplateNotificationMessage],
"prices": CartPrices,
@@ -57798,7 +56790,7 @@ Example
],
"shipping_addresses": [NegotiableQuoteShippingAddress],
"status": "abc123",
- "template_id": 4,
+ "template_id": "4",
"total_quantity": 123.45
}
@@ -57962,14 +56954,14 @@ Example
"activated_at": "abc123",
"company_name": "xyz789",
"expiration_date": "abc123",
- "is_min_max_qty_used": true,
+ "is_min_max_qty_used": false,
"last_shared_at": "xyz789",
"max_order_commitment": 123,
- "min_negotiated_grand_total": 123.45,
+ "min_negotiated_grand_total": 987.65,
"min_order_commitment": 123,
"name": "xyz789",
- "orders_placed": 987,
- "sales_rep_name": "abc123",
+ "orders_placed": 123,
+ "sales_rep_name": "xyz789",
"state": "xyz789",
"status": "abc123",
"submitted_by": "abc123",
@@ -58032,7 +57024,12 @@ Fields
Example
- {"item_id": 4, "max_qty": 987.65, "min_qty": 987.65, "quantity": 987.65}
+ {
+ "item_id": "4",
+ "max_qty": 123.45,
+ "min_qty": 987.65,
+ "quantity": 987.65
+}
@@ -58092,9 +57089,9 @@ Fields
Example
{
"document_identifier": "xyz789",
- "document_name": "xyz789",
- "link_id": 4,
- "reference_document_url": "xyz789"
+ "document_name": "abc123",
+ "link_id": "4",
+ "reference_document_url": "abc123"
}
@@ -58150,7 +57147,7 @@ Example
{
"address": NegotiableQuoteAddressInput,
"customer_address_uid": 4,
- "customer_notes": "xyz789"
+ "customer_notes": "abc123"
}
@@ -58297,7 +57294,7 @@ Example
"items": [NegotiableQuoteTemplateGridItem],
"page_info": SearchResultPageInfo,
"sort_fields": SortFields,
- "total_count": 987
+ "total_count": 123
}
@@ -58350,7 +57347,7 @@ Possible Types
Example
- {"quote_uid": 4}
+ {"quote_uid": "4"}
@@ -58389,7 +57386,7 @@ Fields
Example
- {"quote_uid": 4}
+ {"quote_uid": "4"}
@@ -58435,7 +57432,7 @@ Fields
Example
{
"firstname": "xyz789",
- "lastname": "abc123"
+ "lastname": "xyz789"
}
@@ -58494,7 +57491,7 @@ Example
"items": [NegotiableQuote],
"page_info": SearchResultPageInfo,
"sort_fields": SortFields,
- "total_count": 123
+ "total_count": 987
}
@@ -58540,7 +57537,7 @@ Fields
Example
{
- "message": "abc123",
+ "message": "xyz789",
"uid": "4"
}
@@ -58582,7 +57579,7 @@ Fields
Example
- {"template_id": 4}
+ {"template_id": "4"}
@@ -58630,7 +57627,7 @@ Fields
Example
{
"order_id": "abc123",
- "order_number": "xyz789"
+ "order_number": "abc123"
}
@@ -58815,21 +57812,21 @@ attributeCodes
Example
{
"city": "abc123",
- "company": "abc123",
+ "company": "xyz789",
"country_code": "AF",
"custom_attributesV2": [AttributeValueInterface],
- "fax": "abc123",
- "firstname": "abc123",
+ "fax": "xyz789",
+ "firstname": "xyz789",
"lastname": "abc123",
- "middlename": "abc123",
+ "middlename": "xyz789",
"postcode": "xyz789",
"prefix": "xyz789",
- "region": "abc123",
- "region_id": 4,
- "street": ["xyz789"],
+ "region": "xyz789",
+ "region_id": "4",
+ "street": ["abc123"],
"suffix": "abc123",
"telephone": "xyz789",
- "vat_id": "xyz789"
+ "vat_id": "abc123"
}
@@ -58886,12 +57883,68 @@ Fields
Example
{
- "firstname": "abc123",
+ "firstname": "xyz789",
"lastname": "abc123",
- "middlename": "abc123",
- "prefix": "xyz789",
+ "middlename": "xyz789",
+ "prefix": "abc123",
"suffix": "xyz789"
}
+
+
+
+
+
+
+
+ Types
+
+ OrderInformationInput
+
+
+
+ Description
+ Input to retrieve an order based on details.
+
+
+
+
+
+ Example
+ {
+ "email": "xyz789",
+ "lastname": "abc123",
+ "number": "xyz789"
+}
@@ -59033,7 +58086,7 @@ Fields
Example
{
"discounts": [Discount],
- "eligible_for_return": true,
+ "eligible_for_return": false,
"entered_options": [OrderItemOption],
"gift_message": GiftMessage,
"gift_wrapping": GiftWrapping,
@@ -59044,16 +58097,16 @@ Example
"product_sale_price": Money,
"product_sku": "xyz789",
"product_type": "abc123",
- "product_url_key": "abc123",
+ "product_url_key": "xyz789",
"quantity_canceled": 123.45,
"quantity_invoiced": 123.45,
- "quantity_ordered": 987.65,
+ "quantity_ordered": 123.45,
"quantity_refunded": 123.45,
"quantity_return_requested": 987.65,
- "quantity_returned": 987.65,
- "quantity_shipped": 123.45,
+ "quantity_returned": 123.45,
+ "quantity_shipped": 987.65,
"selected_options": [OrderItemOption],
- "status": "abc123"
+ "status": "xyz789"
}
@@ -59210,12 +58263,12 @@ Possible Types
-
+
-
+
@@ -59237,7 +58290,7 @@ Possible Types
Example
{
"discounts": [Discount],
- "eligible_for_return": true,
+ "eligible_for_return": false,
"entered_options": [OrderItemOption],
"gift_message": GiftMessage,
"gift_wrapping": GiftWrapping,
@@ -59246,18 +58299,18 @@ Example
"product": ProductInterface,
"product_name": "abc123",
"product_sale_price": Money,
- "product_sku": "xyz789",
+ "product_sku": "abc123",
"product_type": "xyz789",
- "product_url_key": "xyz789",
+ "product_url_key": "abc123",
"quantity_canceled": 123.45,
"quantity_invoiced": 987.65,
"quantity_ordered": 123.45,
- "quantity_refunded": 123.45,
- "quantity_return_requested": 987.65,
+ "quantity_refunded": 987.65,
+ "quantity_return_requested": 123.45,
"quantity_returned": 987.65,
- "quantity_shipped": 123.45,
+ "quantity_shipped": 987.65,
"selected_options": [OrderItemOption],
- "status": "xyz789"
+ "status": "abc123"
}
@@ -59303,8 +58356,8 @@ Fields
Example
{
- "label": "xyz789",
- "value": "abc123"
+ "label": "abc123",
+ "value": "xyz789"
}
@@ -59454,7 +58507,7 @@ Fields
Example
{
"additional_data": [KeyValue],
- "name": "xyz789",
+ "name": "abc123",
"type": "abc123"
}
@@ -59519,7 +58572,7 @@ Example
"comments": [SalesCommentItem],
"id": "4",
"items": [ShipmentItemInterface],
- "number": "xyz789",
+ "number": "abc123",
"tracking": [ShipmentTracking]
}
@@ -59561,7 +58614,7 @@ Fields
Example
- {"token": "xyz789"}
+ {"token": "abc123"}
@@ -59609,11 +58662,6 @@ Fields
The final total amount, including shipping, discounts, and taxes.
-
- grand_total_excl_tax - Money!
-
- The grand total of the order, excluding taxes.
-
shipping_handling - ShippingHandling
@@ -59677,7 +58725,6 @@ Example
"discounts": [Discount],
"gift_options": GiftOptionsPrices,
"grand_total": Money,
- "grand_total_excl_tax": Money,
"shipping_handling": ShippingHandling,
"subtotal": Money,
"subtotal_excl_tax": Money,
@@ -59735,8 +58782,8 @@ Fields
Example
{
- "payer_id": "xyz789",
- "token": "xyz789"
+ "payer_id": "abc123",
+ "token": "abc123"
}
@@ -59791,8 +58838,8 @@ Fields
Example
{
"cancel_url": "xyz789",
- "error_url": "abc123",
- "return_url": "xyz789"
+ "error_url": "xyz789",
+ "return_url": "abc123"
}
@@ -59897,9 +58944,9 @@ Fields
Example
{
"mode": "TEST",
- "paypal_url": "abc123",
- "secure_token": "xyz789",
- "secure_token_id": "xyz789"
+ "paypal_url": "xyz789",
+ "secure_token": "abc123",
+ "secure_token_id": "abc123"
}
@@ -59940,7 +58987,7 @@ Fields
Example
- {"cart_id": "xyz789"}
+ {"cart_id": "abc123"}
@@ -60036,7 +59083,7 @@ Fields
Example
{
- "cart_id": "xyz789",
+ "cart_id": "abc123",
"paypal_payload": "abc123"
}
@@ -60120,7 +59167,7 @@ Fields
Example
{
- "cart_id": "abc123",
+ "cart_id": "xyz789",
"urls": PayflowProUrlInput
}
@@ -60175,9 +59222,9 @@ Fields
Example
{
- "cancel_url": "xyz789",
+ "cancel_url": "abc123",
"error_url": "xyz789",
- "return_url": "abc123"
+ "return_url": "xyz789"
}
@@ -60267,11 +59314,6 @@ Possible Types
-
-
-
-
-
@@ -60280,12 +59322,12 @@ Possible Types
Example
{
- "code": "abc123",
- "is_visible": true,
+ "code": "xyz789",
+ "is_visible": false,
"payment_intent": "xyz789",
"sdk_params": [SDKParams],
- "sort_order": "abc123",
- "title": "abc123"
+ "sort_order": "xyz789",
+ "title": "xyz789"
}
@@ -60318,11 +59360,6 @@ Fields
ApplePay payment method configuration
fastlane - FastlaneConfig
- google_pay - GooglePayConfig
Fields
Example
{
"apple_pay": ApplePayConfig,
- "fastlane": FastlaneConfig,
"google_pay": GooglePayConfig,
"hosted_fields": HostedFieldsConfig,
"smart_buttons": SmartButtonsConfig
@@ -60406,13 +59442,6 @@ Values
START_OF_CHECKOUT
ADMIN
Fields
payment_services_paypal_fastlane - FastlaneMethodInput
- payment_services_paypal_google_pay - GooglePayMethodInput
@@ -60617,7 +59640,6 @@ Example
"payflowpro": PayflowProInput, "payflowpro_cc_vault": VaultTokenInput, "payment_services_paypal_apple_pay": ApplePayMethodInput, - "payment_services_paypal_fastlane": FastlaneMethodInput, "payment_services_paypal_google_pay": GooglePayMethodInput, "payment_services_paypal_hosted_fields": HostedFieldsInput, "payment_services_paypal_smart_buttons": SmartButtonMethodInput, @@ -60680,9 +59702,9 @@Fields
Example
{
"id": "xyz789",
- "mp_order_id": "abc123",
+ "mp_order_id": "xyz789",
"payment_source_details": PaymentSourceDetails,
- "status": "xyz789"
+ "status": "abc123"
}
@@ -60993,7 +60015,7 @@ Fields
Example
{
"payer_id": "abc123",
- "token": "xyz789"
+ "token": "abc123"
}
@@ -61061,7 +60083,7 @@ Example
{
"cart_id": "abc123",
"code": "abc123",
- "express_button": false,
+ "express_button": true,
"urls": PaypalExpressUrlsInput,
"use_paypal_credit": true
}
@@ -61156,7 +60178,7 @@ Fields
Example
{
- "edit": "abc123",
+ "edit": "xyz789",
"start": "abc123"
}
@@ -61217,9 +60239,9 @@ Fields
Example
{
- "cancel_url": "xyz789",
- "pending_url": "xyz789",
- "return_url": "abc123",
+ "cancel_url": "abc123",
+ "pending_url": "abc123",
+ "return_url": "xyz789",
"success_url": "abc123"
}
@@ -61297,7 +60319,7 @@ Possible Types
Example
- {"weight": 123.45}
+ {"weight": 987.65}
@@ -61424,19 +60446,19 @@ Example
{
"city": "xyz789",
"contact_name": "abc123",
- "country_id": "abc123",
+ "country_id": "xyz789",
"description": "xyz789",
- "email": "abc123",
+ "email": "xyz789",
"fax": "xyz789",
"latitude": 987.65,
- "longitude": 123.45,
- "name": "abc123",
- "phone": "xyz789",
+ "longitude": 987.65,
+ "name": "xyz789",
+ "phone": "abc123",
"pickup_location_code": "abc123",
- "postcode": "xyz789",
+ "postcode": "abc123",
"region": "abc123",
"region_id": 123,
- "street": "abc123"
+ "street": "xyz789"
}
@@ -61727,7 +60749,7 @@ Example
{
"items": [PickupLocation],
"page_info": SearchResultPageInfo,
- "total_count": 987
+ "total_count": 123
}
@@ -61768,7 +60790,7 @@ Fields
Example
- {"quote_uid": "4"}
+ {"quote_uid": 4}
@@ -61853,7 +60875,7 @@ Fields
Example
{
"code": "CART_NOT_FOUND",
- "message": "xyz789"
+ "message": "abc123"
}
@@ -62066,7 +61088,7 @@ Fields
- errors - [PlaceOrderError]
+ errors - [PlaceOrderError]!
An array of place order errors.
@@ -62433,7 +61455,7 @@ Example
{
"discount_percentage": 123.45,
"main_final_price": 987.65,
- "main_price": 987.65
+ "main_price": 123.45
}
@@ -63032,7 +62054,7 @@ Fields
Example
- {"amount_off": 123.45, "percent_off": 987.65}
+ {"amount_off": 123.45, "percent_off": 123.45}
@@ -63383,11 +62405,6 @@ Fields
The media item's position after it has been sorted.
-
- types - [String]
-
- Array of image types. It can have the following values: image, small_image, thumbnail.
-
url - String
@@ -63401,10 +62418,9 @@ Fields
Example
{
- "disabled": false,
- "label": "xyz789",
+ "disabled": true,
+ "label": "abc123",
"position": 987,
- "types": ["abc123"],
"url": "xyz789"
}
@@ -63838,6 +62854,11 @@ currentPage
+
+ rules - [CatalogRule]
+
+ Provides applied catalog rules in the current active cart
+
sale - Int
@@ -64029,12 +63050,12 @@ Possible Types
-
+
-
+
@@ -64056,83 +63077,84 @@ Possible Types
Example
{
"activity": "xyz789",
- "attribute_set_id": 123,
- "canonical_url": "abc123",
+ "attribute_set_id": 987,
+ "canonical_url": "xyz789",
"categories": [CategoryInterface],
- "category_gear": "abc123",
- "climate": "abc123",
- "collar": "xyz789",
+ "category_gear": "xyz789",
+ "climate": "xyz789",
+ "collar": "abc123",
"color": 987,
- "country_of_manufacture": "abc123",
+ "country_of_manufacture": "xyz789",
"created_at": "abc123",
"crosssell_products": [ProductInterface],
"custom_attributesV2": ProductCustomAttributes,
"description": ComplexTextValue,
- "eco_collection": 987,
- "erin_recommends": 123,
- "features_bags": "xyz789",
+ "eco_collection": 123,
+ "erin_recommends": 987,
+ "features_bags": "abc123",
"format": 987,
"gender": "abc123",
"gift_message_available": true,
"gift_wrapping_available": false,
"gift_wrapping_price": Money,
- "id": 123,
+ "id": 987,
"image": ProductImage,
- "is_returnable": "abc123",
- "manufacturer": 123,
+ "is_returnable": "xyz789",
+ "manufacturer": 987,
"material": "xyz789",
- "max_sale_qty": 987.65,
+ "max_sale_qty": 123.45,
"media_gallery": [MediaGalleryInterface],
"media_gallery_entries": [MediaGalleryEntry],
- "meta_description": "xyz789",
+ "meta_description": "abc123",
"meta_keyword": "xyz789",
"meta_title": "abc123",
"min_sale_qty": 987.65,
- "name": "abc123",
- "new": 987,
- "new_from_date": "abc123",
- "new_to_date": "abc123",
- "only_x_left_in_stock": 987.65,
- "options_container": "xyz789",
- "pattern": "xyz789",
- "performance_fabric": 987,
+ "name": "xyz789",
+ "new": 123,
+ "new_from_date": "xyz789",
+ "new_to_date": "xyz789",
+ "only_x_left_in_stock": 123.45,
+ "options_container": "abc123",
+ "pattern": "abc123",
+ "performance_fabric": 123,
"price": ProductPrices,
"price_range": PriceRange,
"price_tiers": [TierPrice],
"product_links": [ProductLinksInterface],
"purpose": 123,
"quantity": 123.45,
- "rating_summary": 987.65,
+ "rating_summary": 123.45,
"related_products": [ProductInterface],
"review_count": 123,
"reviews": ProductReviews,
+ "rules": [CatalogRule],
"sale": 987,
"short_description": ComplexTextValue,
- "size": 123,
+ "size": 987,
"sku": "xyz789",
"sleeve": "xyz789",
"small_image": ProductImage,
- "special_from_date": "xyz789",
+ "special_from_date": "abc123",
"special_price": 123.45,
- "special_to_date": "abc123",
+ "special_to_date": "xyz789",
"staged": true,
"stock_status": "IN_STOCK",
- "strap_bags": "abc123",
- "style_bags": "abc123",
- "style_bottom": "xyz789",
+ "strap_bags": "xyz789",
+ "style_bags": "xyz789",
+ "style_bottom": "abc123",
"style_general": "xyz789",
- "swatch_image": "abc123",
+ "swatch_image": "xyz789",
"thumbnail": ProductImage,
- "tier_price": 987.65,
+ "tier_price": 123.45,
"tier_prices": [ProductTierPrices],
"type_id": "abc123",
- "uid": "4",
- "updated_at": "xyz789",
+ "uid": 4,
+ "updated_at": "abc123",
"upsell_products": [ProductInterface],
"url_key": "abc123",
- "url_path": "abc123",
+ "url_path": "xyz789",
"url_rewrites": [UrlRewrite],
- "url_suffix": "xyz789",
+ "url_suffix": "abc123",
"websites": [Website]
}
@@ -64195,8 +63217,8 @@ Fields
Example
{
"link_type": "abc123",
- "linked_product_sku": "abc123",
- "linked_product_type": "abc123",
+ "linked_product_sku": "xyz789",
+ "linked_product_type": "xyz789",
"position": 123,
"sku": "abc123"
}
@@ -64276,11 +63298,11 @@ Possible Types
Example
{
- "link_type": "xyz789",
+ "link_type": "abc123",
"linked_product_sku": "xyz789",
- "linked_product_type": "xyz789",
+ "linked_product_type": "abc123",
"position": 123,
- "sku": "xyz789"
+ "sku": "abc123"
}
@@ -64331,9 +63353,9 @@ Fields
Example
{
- "base64_encoded_data": "xyz789",
- "name": "abc123",
- "type": "xyz789"
+ "base64_encoded_data": "abc123",
+ "name": "xyz789",
+ "type": "abc123"
}
@@ -64399,11 +63421,11 @@ Fields
Example
{
- "media_type": "xyz789",
- "video_description": "abc123",
- "video_metadata": "abc123",
- "video_provider": "abc123",
- "video_title": "abc123",
+ "media_type": "abc123",
+ "video_description": "xyz789",
+ "video_metadata": "xyz789",
+ "video_provider": "xyz789",
+ "video_title": "xyz789",
"video_url": "abc123"
}
@@ -64590,13 +63612,13 @@ Fields
Example
{
- "average_rating": 123.45,
- "created_at": "abc123",
+ "average_rating": 987.65,
+ "created_at": "xyz789",
"nickname": "xyz789",
"product": ProductInterface,
"ratings_breakdown": [ProductReviewRating],
"summary": "xyz789",
- "text": "abc123"
+ "text": "xyz789"
}
@@ -64642,7 +63664,7 @@ Fields
Example
{
- "name": "xyz789",
+ "name": "abc123",
"value": "abc123"
}
@@ -64691,8 +63713,8 @@ Fields
Example
{
- "id": "abc123",
- "value_id": "abc123"
+ "id": "xyz789",
+ "value_id": "xyz789"
}
@@ -64744,7 +63766,7 @@ Fields
Example
{
"id": "xyz789",
- "name": "abc123",
+ "name": "xyz789",
"values": [ProductReviewRatingValueMetadata]
}
@@ -64791,8 +63813,8 @@ Fields
Example
{
- "value": "xyz789",
- "value_id": "xyz789"
+ "value": "abc123",
+ "value_id": "abc123"
}
@@ -64992,11 +64014,11 @@ Fields
Example
{
- "customer_group_id": "abc123",
- "percentage_value": 987.65,
- "qty": 123.45,
- "value": 123.45,
- "website_id": 123.45
+ "customer_group_id": "xyz789",
+ "percentage_value": 123.45,
+ "qty": 987.65,
+ "value": 987.65,
+ "website_id": 987.65
}
@@ -65039,11 +64061,6 @@ Fields
The media item's position after it has been sorted.
-
- types - [String]
-
- Array of image types. It can have the following values: image, small_image, thumbnail.
-
url - String
@@ -65064,8 +64081,7 @@ Example
{
"disabled": true,
"label": "abc123",
- "position": 987,
- "types": ["xyz789"],
+ "position": 123,
"url": "abc123",
"video_content": ProductMediaGalleryEntriesVideoContent
}
@@ -65257,14 +64273,14 @@ Example
"approval_flow": [PurchaseOrderRuleApprovalFlow],
"available_actions": ["REJECT"],
"comments": [PurchaseOrderComment],
- "created_at": "xyz789",
+ "created_at": "abc123",
"created_by": Customer,
"history_log": [PurchaseOrderHistoryItem],
- "number": "abc123",
+ "number": "xyz789",
"order": CustomerOrder,
"quote": Cart,
"status": "PENDING",
- "uid": "4",
+ "uid": 4,
"updated_at": "abc123"
}
@@ -65375,7 +64391,7 @@ Fields
Example
- {"message": "abc123", "type": "NOT_FOUND"}
+ {"message": "xyz789", "type": "NOT_FOUND"}
@@ -65435,11 +64451,11 @@ Fields
Example
{
- "message": "abc123",
- "name": "abc123",
+ "message": "xyz789",
+ "name": "xyz789",
"role": "xyz789",
"status": "PENDING",
- "updated_at": "xyz789"
+ "updated_at": "abc123"
}
@@ -65580,8 +64596,8 @@ Example
"approver_roles": [CompanyRole],
"condition": PurchaseOrderApprovalRuleConditionInterface,
"created_at": "xyz789",
- "created_by": "xyz789",
- "description": "xyz789",
+ "created_by": "abc123",
+ "description": "abc123",
"name": "abc123",
"status": "ENABLED",
"uid": "4",
@@ -65812,7 +64828,7 @@ Fields
Example
- {"attribute": "GRAND_TOTAL", "operator": "MORE_THAN", "quantity": 123}
+ {"attribute": "GRAND_TOTAL", "operator": "MORE_THAN", "quantity": 987}
@@ -66269,10 +65285,10 @@ Fields
Example
{
- "activity": "xyz789",
- "created_at": "abc123",
- "message": "xyz789",
- "uid": "4"
+ "activity": "abc123",
+ "created_at": "xyz789",
+ "message": "abc123",
+ "uid": 4
}
@@ -66465,7 +65481,7 @@ Example
{
"items": [PurchaseOrder],
"page_info": SearchResultPageInfo,
- "total_count": 123
+ "total_count": 987
}
@@ -66614,7 +65630,7 @@ Example
{
"company_purchase_orders": true,
"created_date": FilterRangeTypeInput,
- "require_my_approval": false,
+ "require_my_approval": true,
"status": "PENDING"
}
@@ -66884,14 +65900,14 @@ Fields
Example
{
- "badge_position": "xyz789",
+ "badge_position": "abc123",
"language_code": "abc123",
"minimum_score": 987.65,
"re_captcha_type": "INVISIBLE",
"technical_failure_message": "xyz789",
"theme": "xyz789",
"validation_failure_message": "xyz789",
- "website_key": "xyz789"
+ "website_key": "abc123"
}
@@ -66967,14 +65983,14 @@ Fields
Example
{
- "badge_position": "xyz789",
+ "badge_position": "abc123",
"failure_message": "xyz789",
"forms": ["PLACE_ORDER"],
"is_enabled": true,
"language_code": "xyz789",
"minimum_score": 987.65,
"theme": "abc123",
- "website_key": "xyz789"
+ "website_key": "abc123"
}
@@ -67179,9 +66195,9 @@ Fields
Example
{
- "code": "abc123",
- "id": 123,
- "name": "abc123"
+ "code": "xyz789",
+ "id": 987,
+ "name": "xyz789"
}
@@ -67222,7 +66238,7 @@ Fields
Example
- {"cart_id": "abc123"}
+ {"cart_id": "xyz789"}
@@ -67308,8 +66324,8 @@ Fields
Example
{
- "cart_id": "abc123",
- "coupon_codes": ["xyz789"]
+ "cart_id": "xyz789",
+ "coupon_codes": ["abc123"]
}
@@ -67476,7 +66492,7 @@ Fields
Example
- {"success": false}
+ {"success": true}
@@ -67568,7 +66584,7 @@ Fields
Example
{
- "cart_id": "abc123",
+ "cart_id": "xyz789",
"cart_item_id": 123,
"cart_item_uid": "4"
}
@@ -67656,10 +66672,7 @@ Fields
Example
- {
- "quote_item_uids": ["4"],
- "quote_uid": "4"
-}
+ {"quote_item_uids": ["4"], "quote_uid": 4}
@@ -67744,10 +66757,7 @@ Fields
Example
- {
- "item_uids": ["4"],
- "template_id": "4"
-}
+ {"item_uids": ["4"], "template_id": 4}
@@ -67793,7 +66803,10 @@ Fields
Example
- {"products": [4], "uid": 4}
+ {
+ "products": ["4"],
+ "uid": "4"
+}
@@ -68090,9 +67103,9 @@ Fields
Example
{
- "quote_comment": "abc123",
+ "quote_comment": "xyz789",
"quote_name": "abc123",
- "quote_uid": 4
+ "quote_uid": "4"
}
@@ -68238,10 +67251,10 @@ Fields
Example
{
- "comment_text": "xyz789",
- "contact_email": "abc123",
+ "comment_text": "abc123",
+ "contact_email": "xyz789",
"items": [RequestReturnItemInput],
- "token": "xyz789"
+ "token": "abc123"
}
@@ -68301,10 +67314,10 @@ Fields
Example
{
- "cart_id": 4,
+ "cart_id": "4",
"comment": NegotiableQuoteCommentInput,
- "is_draft": false,
- "quote_name": "xyz789"
+ "is_draft": true,
+ "quote_name": "abc123"
}
@@ -68443,8 +67456,8 @@ Fields
Example
{
- "comment_text": "abc123",
- "contact_email": "xyz789",
+ "comment_text": "xyz789",
+ "contact_email": "abc123",
"items": [RequestReturnItemInput],
"order_uid": 4
}
@@ -68510,7 +67523,7 @@ Example
EnteredCustomAttributeInput
],
"order_item_uid": 4,
- "quantity_to_return": 123.45,
+ "quantity_to_return": 987.65,
"selected_custom_attributes": [
SelectedCustomAttributeInput
]
@@ -68666,10 +67679,10 @@ Example
{
"description": "xyz789",
"items": RequistionListItems,
- "items_count": 987,
+ "items_count": 123,
"name": "xyz789",
- "uid": 4,
- "updated_at": "xyz789"
+ "uid": "4",
+ "updated_at": "abc123"
}
@@ -68886,9 +67899,9 @@ Fields
Example
{
"entered_options": [EnteredOptionInput],
- "parent_sku": "xyz789",
+ "parent_sku": "abc123",
"quantity": 987.65,
- "selected_options": ["abc123"],
+ "selected_options": ["xyz789"],
"sku": "abc123"
}
@@ -68942,7 +67955,7 @@ Example
{
"items": [RequisitionList],
"page_info": SearchResultPageInfo,
- "total_count": 987
+ "total_count": 123
}
@@ -68995,7 +68008,7 @@ Example
{
"items": [RequisitionListItemInterface],
"page_info": SearchResultPageInfo,
- "total_pages": 123
+ "total_pages": 987
}
@@ -69083,10 +68096,10 @@ Example
{
"available_shipping_carriers": [ReturnShippingCarrier],
"comments": [ReturnComment],
- "created_at": "abc123",
+ "created_at": "xyz789",
"customer": ReturnCustomer,
"items": [ReturnItem],
- "number": "abc123",
+ "number": "xyz789",
"order": CustomerOrder,
"shipping": ReturnShipping,
"status": "PENDING",
@@ -69147,9 +68160,9 @@ Fields
Example
{
"author_name": "abc123",
- "created_at": "abc123",
- "text": "xyz789",
- "uid": "4"
+ "created_at": "xyz789",
+ "text": "abc123",
+ "uid": 4
}
@@ -69201,7 +68214,7 @@ Fields
Example
{
"label": "abc123",
- "uid": 4,
+ "uid": "4",
"value": "abc123"
}
@@ -69254,8 +68267,8 @@ Fields
Example
{
"email": "abc123",
- "firstname": "xyz789",
- "lastname": "abc123"
+ "firstname": "abc123",
+ "lastname": "xyz789"
}
@@ -69330,7 +68343,7 @@ Example
"custom_attributes": [ReturnCustomAttribute],
"custom_attributesV2": [AttributeValueInterface],
"order_item": OrderItemInterface,
- "quantity": 123.45,
+ "quantity": 987.65,
"request_quantity": 123.45,
"status": "PENDING",
"uid": 4
@@ -69435,17 +68448,17 @@ Fields
Example
{
"code": "4",
- "default_value": "abc123",
+ "default_value": "xyz789",
"entity_type": "CATALOG_PRODUCT",
"frontend_class": "abc123",
"frontend_input": "BOOLEAN",
"input_filter": "NONE",
- "is_required": false,
+ "is_required": true,
"is_unique": false,
"label": "abc123",
- "multiline_count": 123,
+ "multiline_count": 987,
"options": [CustomAttributeOptionInterface],
- "sort_order": 123,
+ "sort_order": 987,
"validate_rules": [ValidationRule]
}
@@ -69649,13 +68662,13 @@ Fields
Example
{
- "city": "xyz789",
+ "city": "abc123",
"contact_name": "abc123",
"country": Country,
"postcode": "abc123",
"region": Region,
- "street": ["xyz789"],
- "telephone": "abc123"
+ "street": ["abc123"],
+ "telephone": "xyz789"
}
@@ -69700,7 +68713,7 @@ Fields
Example
- {"label": "xyz789", "uid": 4}
+ {"label": "abc123", "uid": 4}
@@ -69757,7 +68770,7 @@ Example
{
"carrier": ReturnShippingCarrier,
"status": ReturnShippingTrackingStatus,
- "tracking_number": "abc123",
+ "tracking_number": "xyz789",
"uid": "4"
}
@@ -70060,7 +69073,7 @@ Fields
Example
- {"result": true}
+ {"result": false}
@@ -70216,8 +69229,8 @@ Example
{
"balance": RewardPointsAmount,
"change_reason": "xyz789",
- "date": "abc123",
- "points_change": 987.65
+ "date": "xyz789",
+ "points_change": 123.45
}
@@ -70309,7 +69322,7 @@ Fields
Example
- {"currency_amount": 987.65, "points": 987.65}
+ {"currency_amount": 123.45, "points": 123.45}
@@ -70476,12 +69489,12 @@ Possible Types
-
+
-
+
@@ -70491,17 +69504,17 @@ Possible Types
-
+
-
+
-
+
@@ -70512,7 +69525,7 @@ Possible Types
Example
{
- "redirect_code": 123,
+ "redirect_code": 987,
"relative_url": "abc123",
"type": "CMS_PAGE"
}
@@ -70565,7 +69578,7 @@ Fields
Example
{
- "redirect_code": 123,
+ "redirect_code": 987,
"relative_url": "xyz789",
"type": "CMS_PAGE"
}
@@ -70613,8 +69626,8 @@ Fields
Example
{
- "name": "abc123",
- "value": "abc123"
+ "name": "xyz789",
+ "value": "xyz789"
}
@@ -70661,7 +69674,7 @@ Fields
Example
{
"message": "xyz789",
- "timestamp": "abc123"
+ "timestamp": "xyz789"
}
@@ -70766,7 +69779,7 @@ Fields
Example
- {"current_page": 987, "page_size": 987, "total_pages": 987}
+ {"current_page": 987, "page_size": 123, "total_pages": 123}
@@ -70805,7 +69818,7 @@ Fields
Example
- {"search": "xyz789"}
+ {"search": "abc123"}
@@ -70867,10 +69880,10 @@ Fields
Example
{
- "id": 123,
- "label": "xyz789",
- "type": "abc123",
- "uid": 4,
+ "id": 987,
+ "label": "abc123",
+ "type": "xyz789",
+ "uid": "4",
"values": [SelectedBundleOptionValue]
}
@@ -70944,11 +69957,11 @@ Fields
Example
{
"id": 123,
- "label": "abc123",
+ "label": "xyz789",
"original_price": Money,
"price": 123.45,
"priceV2": Money,
- "quantity": 987.65,
+ "quantity": 123.45,
"uid": 4
}
@@ -71021,9 +70034,9 @@ Example
{
"configurable_product_option_uid": 4,
"configurable_product_option_value_uid": "4",
- "id": 123,
- "option_label": "abc123",
- "value_id": 987,
+ "id": 987,
+ "option_label": "xyz789",
+ "value_id": 123,
"value_label": "abc123"
}
@@ -71146,11 +70159,11 @@ Fields
Example
{
- "customizable_option_uid": 4,
+ "customizable_option_uid": "4",
"id": 987,
- "is_required": true,
+ "is_required": false,
"label": "abc123",
- "sort_order": 123,
+ "sort_order": 987,
"type": "abc123",
"values": [SelectedCustomizableOptionValue]
}
@@ -71216,7 +70229,7 @@ Fields
Example
{
"customizable_option_value_uid": 4,
- "id": 987,
+ "id": 123,
"label": "xyz789",
"price": CartItemSelectedOptionValuePrice,
"value": "abc123"
@@ -71271,8 +70284,8 @@ Fields
Example
{
"code": "xyz789",
- "purchase_order_number": "abc123",
- "title": "abc123"
+ "purchase_order_number": "xyz789",
+ "title": "xyz789"
}
@@ -71352,7 +70365,7 @@ Example
{
"amount": Money,
"base_amount": Money,
- "carrier_code": "abc123",
+ "carrier_code": "xyz789",
"carrier_title": "xyz789",
"method_code": "xyz789",
"method_title": "abc123",
@@ -71411,7 +70424,7 @@ Fields
Example
{
- "product_id": 987,
+ "product_id": 123,
"recipients": [SendEmailToFriendRecipientInput],
"sender": SendEmailToFriendSenderInput
}
@@ -71555,7 +70568,7 @@ Fields
Example
{
- "email": "xyz789",
+ "email": "abc123",
"name": "xyz789"
}
@@ -71710,7 +70723,7 @@ Fields
Example
- {"enabled_for_customers": false, "enabled_for_guests": false}
+ {"enabled_for_customers": true, "enabled_for_guests": true}
@@ -71846,7 +70859,7 @@ Fields
Example
{
"billing_address": BillingAddressInput,
- "cart_id": "xyz789"
+ "cart_id": "abc123"
}
@@ -71887,50 +70900,6 @@ Fields
Example
{"cart": Cart}
-
-
-
-
-
-
-
- Types
-
- SetCartAsInactiveOutput
-
-
-
- Description
- Sets the cart as inactive
-
-
-
-
-
- Example
- {"error": "xyz789", "success": true}
@@ -71998,7 +70967,7 @@ Example
"cart_id": "abc123",
"gift_message": GiftMessageInput,
"gift_receipt_included": false,
- "gift_wrapping_id": 4,
+ "gift_wrapping_id": "4",
"printed_card_included": false
}
@@ -72086,8 +71055,8 @@ Fields
Example
{
- "cart_id": "abc123",
- "email": "abc123"
+ "cart_id": "xyz789",
+ "email": "xyz789"
}
@@ -72214,7 +71183,7 @@ Fields
Example
{
"billing_address": NegotiableQuoteBillingAddressInput,
- "quote_uid": "4"
+ "quote_uid": 4
}
@@ -72302,7 +71271,7 @@ Fields
Example
{
"payment_method": NegotiableQuotePaymentMethodInput,
- "quote_uid": "4"
+ "quote_uid": 4
}
@@ -72395,7 +71364,7 @@ Fields
Example
{
- "customer_address_id": 4,
+ "customer_address_id": "4",
"quote_uid": "4",
"shipping_addresses": [
NegotiableQuoteShippingAddressInput
@@ -72672,7 +71641,7 @@ Fields
Example
{
- "cart_id": "xyz789",
+ "cart_id": "abc123",
"payment_method": PaymentMethodInput
}
@@ -72760,7 +71729,7 @@ Fields
Example
{
- "cart_id": "xyz789",
+ "cart_id": "abc123",
"shipping_addresses": [ShippingAddressInput]
}
@@ -72848,7 +71817,7 @@ Fields
Example
{
- "cart_id": "abc123",
+ "cart_id": "xyz789",
"shipping_methods": [ShippingMethodInput]
}
@@ -72937,7 +71906,7 @@ Fields
Example
{
"email": "xyz789",
- "name": "abc123"
+ "name": "xyz789"
}
@@ -72977,7 +71946,7 @@ Fields
Example
- {"is_shared": true}
+ {"is_shared": false}
@@ -73139,8 +72108,8 @@ Example
"order_item": OrderItemInterface,
"product_name": "abc123",
"product_sale_price": Money,
- "product_sku": "abc123",
- "quantity_shipped": 987.65
+ "product_sku": "xyz789",
+ "quantity_shipped": 123.45
}
@@ -73290,8 +72259,8 @@ Fields
Example
{
"carrier": "abc123",
- "number": "abc123",
- "title": "abc123"
+ "number": "xyz789",
+ "title": "xyz789"
}
@@ -73331,12 +72300,6 @@ Fields
customer_address_uid - ID
- customer_notes - String
@@ -73358,10 +72321,9 @@ Fields
Example
{
"address": CartAddressInput,
- "customer_address_id": 987,
- "customer_address_uid": "4",
- "customer_notes": "abc123",
- "pickup_location_code": "abc123"
+ "customer_address_id": 123,
+ "customer_notes": "xyz789",
+ "pickup_location_code": "xyz789"
}
@@ -73426,11 +72388,6 @@ Fields
customer_address_uid - ID
- customer_notes - String
Fields
id - Int
- customer_address_uid instead.
+ id - Int
items_weight - Float
@@ -73516,9 +72472,9 @@ Fields
uid - ID!
+ uid - String!
vat_id - String
@@ -73540,24 +72496,23 @@ Example
"company": "abc123", "country": CartAddressCountry, "custom_attributes": [AttributeValueInterface], - "customer_address_uid": "4", "customer_notes": "xyz789", "fax": "xyz789", "firstname": "xyz789", "id": 987, - "items_weight": 123.45, - "lastname": "abc123", - "middlename": "abc123", + "items_weight": 987.65, + "lastname": "xyz789", + "middlename": "xyz789", "pickup_location_code": "abc123", - "postcode": "xyz789", + "postcode": "abc123", "prefix": "xyz789", "region": CartAddressRegion, "same_as_billing": true, "selected_shipping_method": SelectedShippingMethod, - "street": ["xyz789"], - "suffix": "abc123", + "street": ["abc123"], + "suffix": "xyz789", "telephone": "abc123", - "uid": 4, + "uid": "xyz789", "vat_id": "abc123" } @@ -73710,7 +72665,7 @@Fields
Example
{
- "carrier_code": "abc123",
+ "carrier_code": "xyz789",
"method_code": "xyz789"
}
@@ -73840,17 +72795,17 @@ Example
"errors": [CartItemError], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": "xyz789", - "is_available": true, - "max_qty": 987.65, + "id": "abc123", + "is_available": false, + "max_qty": 123.45, "min_qty": 987.65, - "not_available_message": "xyz789", + "not_available_message": "abc123", "note_from_buyer": [ItemNote], "note_from_seller": [ItemNote], "prices": CartItemPrices, "product": ProductInterface, - "quantity": 987.65, - "uid": "4" + "quantity": 123.45, + "uid": 4 }currentPage
rules - [CatalogRule]
+ sale - Int
currentPage
Example
{
- "activity": "abc123",
- "attribute_set_id": 123,
- "canonical_url": "abc123",
+ "activity": "xyz789",
+ "attribute_set_id": 987,
+ "canonical_url": "xyz789",
"categories": [CategoryInterface],
- "category_gear": "abc123",
- "climate": "abc123",
- "collar": "xyz789",
- "color": 987,
+ "category_gear": "xyz789",
+ "climate": "xyz789",
+ "collar": "abc123",
+ "color": 123,
"country_of_manufacture": "xyz789",
- "created_at": "xyz789",
+ "created_at": "abc123",
"crosssell_products": [ProductInterface],
"custom_attributesV2": ProductCustomAttributes,
"description": ComplexTextValue,
"eco_collection": 123,
- "erin_recommends": 987,
- "features_bags": "xyz789",
- "format": 123,
+ "erin_recommends": 123,
+ "features_bags": "abc123",
+ "format": 987,
"gender": "abc123",
"gift_message_available": false,
- "gift_wrapping_available": true,
+ "gift_wrapping_available": false,
"gift_wrapping_price": Money,
- "id": 123,
+ "id": 987,
"image": ProductImage,
- "is_returnable": "xyz789",
+ "is_returnable": "abc123",
"manufacturer": 987,
"material": "xyz789",
- "max_sale_qty": 123.45,
+ "max_sale_qty": 987.65,
"media_gallery": [MediaGalleryInterface],
"media_gallery_entries": [MediaGalleryEntry],
"meta_description": "abc123",
"meta_keyword": "abc123",
"meta_title": "xyz789",
- "min_sale_qty": 123.45,
+ "min_sale_qty": 987.65,
"name": "xyz789",
"new": 123,
"new_from_date": "abc123",
- "new_to_date": "xyz789",
- "only_x_left_in_stock": 987.65,
+ "new_to_date": "abc123",
+ "only_x_left_in_stock": 123.45,
"options": [CustomizableOptionInterface],
"options_container": "xyz789",
- "pattern": "xyz789",
+ "pattern": "abc123",
"performance_fabric": 123,
"price": ProductPrices,
"price_range": PriceRange,
"price_tiers": [TierPrice],
"product_links": [ProductLinksInterface],
"purpose": 987,
- "quantity": 123.45,
+ "quantity": 987.65,
"rating_summary": 987.65,
"redirect_code": 123,
"related_products": [ProductInterface],
"relative_url": "abc123",
"review_count": 987,
"reviews": ProductReviews,
- "sale": 987,
+ "rules": [CatalogRule],
+ "sale": 123,
"short_description": ComplexTextValue,
- "size": 987,
- "sku": "xyz789",
+ "size": 123,
+ "sku": "abc123",
"sleeve": "abc123",
"small_image": ProductImage,
- "special_from_date": "abc123",
+ "special_from_date": "xyz789",
"special_price": 123.45,
"special_to_date": "abc123",
"staged": false,
"stock_status": "IN_STOCK",
"strap_bags": "xyz789",
- "style_bags": "xyz789",
+ "style_bags": "abc123",
"style_bottom": "abc123",
- "style_general": "abc123",
+ "style_general": "xyz789",
"swatch_image": "xyz789",
"thumbnail": ProductImage,
"tier_price": 987.65,
"tier_prices": [ProductTierPrices],
"type": "CMS_PAGE",
- "type_id": "abc123",
+ "type_id": "xyz789",
"uid": 4,
"updated_at": "xyz789",
"upsell_products": [ProductInterface],
- "url_key": "xyz789",
+ "url_key": "abc123",
"url_path": "abc123",
"url_rewrites": [UrlRewrite],
- "url_suffix": "xyz789",
+ "url_suffix": "abc123",
"websites": [Website],
"weight": 123.45
}
@@ -74586,8 +73547,8 @@ Example
{
"customizable_options": [SelectedCustomizableOption],
"product": ProductInterface,
- "quantity": 987.65,
- "uid": 4
+ "quantity": 123.45,
+ "uid": "4"
}
@@ -74653,12 +73614,12 @@ Fields
Example
{
- "added_at": "xyz789",
+ "added_at": "abc123",
"customizable_options": [SelectedCustomizableOption],
- "description": "xyz789",
- "id": "4",
+ "description": "abc123",
+ "id": 4,
"product": ProductInterface,
- "quantity": 987.65
+ "quantity": 123.45
}
@@ -74713,8 +73674,8 @@ Fields
Example
{
"payment_source": "xyz789",
- "payments_order_id": "abc123",
- "paypal_order_id": "xyz789"
+ "payments_order_id": "xyz789",
+ "paypal_order_id": "abc123"
}
@@ -74738,11 +73699,6 @@ Fields
Example
{
- "activity": "abc123",
- "attribute_set_id": 123,
- "canonical_url": "abc123",
+ "activity": "xyz789",
+ "attribute_set_id": 987,
+ "canonical_url": "xyz789",
"categories": [CategoryInterface],
- "category_gear": "abc123",
- "climate": "abc123",
- "collar": "xyz789",
- "color": 987,
+ "category_gear": "xyz789",
+ "climate": "xyz789",
+ "collar": "abc123",
+ "color": 123,
"country_of_manufacture": "xyz789",
- "created_at": "xyz789",
+ "created_at": "abc123",
"crosssell_products": [ProductInterface],
"custom_attributesV2": ProductCustomAttributes,
"description": ComplexTextValue,
"eco_collection": 123,
- "erin_recommends": 987,
- "features_bags": "xyz789",
- "format": 123,
+ "erin_recommends": 123,
+ "features_bags": "abc123",
+ "format": 987,
"gender": "abc123",
"gift_message_available": false,
- "gift_wrapping_available": true,
+ "gift_wrapping_available": false,
"gift_wrapping_price": Money,
- "id": 123,
+ "id": 987,
"image": ProductImage,
- "is_returnable": "xyz789",
+ "is_returnable": "abc123",
"manufacturer": 987,
"material": "xyz789",
- "max_sale_qty": 123.45,
+ "max_sale_qty": 987.65,
"media_gallery": [MediaGalleryInterface],
"media_gallery_entries": [MediaGalleryEntry],
"meta_description": "abc123",
"meta_keyword": "abc123",
"meta_title": "xyz789",
- "min_sale_qty": 123.45,
+ "min_sale_qty": 987.65,
"name": "xyz789",
"new": 123,
"new_from_date": "abc123",
- "new_to_date": "xyz789",
- "only_x_left_in_stock": 987.65,
+ "new_to_date": "abc123",
+ "only_x_left_in_stock": 123.45,
"options": [CustomizableOptionInterface],
"options_container": "xyz789",
- "pattern": "xyz789",
+ "pattern": "abc123",
"performance_fabric": 123,
"price": ProductPrices,
"price_range": PriceRange,
"price_tiers": [TierPrice],
"product_links": [ProductLinksInterface],
"purpose": 987,
- "quantity": 123.45,
+ "quantity": 987.65,
"rating_summary": 987.65,
"redirect_code": 123,
"related_products": [ProductInterface],
"relative_url": "abc123",
"review_count": 987,
"reviews": ProductReviews,
- "sale": 987,
+ "rules": [CatalogRule],
+ "sale": 123,
"short_description": ComplexTextValue,
- "size": 987,
- "sku": "xyz789",
+ "size": 123,
+ "sku": "abc123",
"sleeve": "abc123",
"small_image": ProductImage,
- "special_from_date": "abc123",
+ "special_from_date": "xyz789",
"special_price": 123.45,
"special_to_date": "abc123",
"staged": false,
"stock_status": "IN_STOCK",
"strap_bags": "xyz789",
- "style_bags": "xyz789",
+ "style_bags": "abc123",
"style_bottom": "abc123",
- "style_general": "abc123",
+ "style_general": "xyz789",
"swatch_image": "xyz789",
"thumbnail": ProductImage,
"tier_price": 987.65,
"tier_prices": [ProductTierPrices],
"type": "CMS_PAGE",
- "type_id": "abc123",
+ "type_id": "xyz789",
"uid": 4,
"updated_at": "xyz789",
"upsell_products": [ProductInterface],
- "url_key": "xyz789",
+ "url_key": "abc123",
"url_path": "abc123",
"url_rewrites": [UrlRewrite],
- "url_suffix": "xyz789",
+ "url_suffix": "abc123",
"websites": [Website],
"weight": 123.45
}
@@ -74586,8 +73547,8 @@ Example
{
"customizable_options": [SelectedCustomizableOption],
"product": ProductInterface,
- "quantity": 987.65,
- "uid": 4
+ "quantity": 123.45,
+ "uid": "4"
}
@@ -74653,12 +73614,12 @@ Fields
Example
{
- "added_at": "xyz789",
+ "added_at": "abc123",
"customizable_options": [SelectedCustomizableOption],
- "description": "xyz789",
- "id": "4",
+ "description": "abc123",
+ "id": 4,
"product": ProductInterface,
- "quantity": 987.65
+ "quantity": 123.45
}
@@ -74713,8 +73674,8 @@ Fields
Example
{
"payment_source": "xyz789",
- "payments_order_id": "abc123",
- "paypal_order_id": "xyz789"
+ "payments_order_id": "xyz789",
+ "paypal_order_id": "abc123"
}
@@ -74738,11 +73699,6 @@ Fields
app_switch_when_available - Boolean
- button_styles - ButtonStyles
Fields
Example
{
- "app_switch_when_available": false,
"button_styles": ButtonStyles,
- "code": "xyz789",
+ "code": "abc123",
"display_message": false,
"display_venmo": true,
- "is_visible": true,
+ "is_visible": false,
"message_styles": MessageStyles,
"payment_intent": "xyz789",
"sdk_params": [SDKParams],
@@ -74905,7 +73860,7 @@ Fields
Example
{
- "label": "xyz789",
+ "label": "abc123",
"value": "xyz789"
}
@@ -74952,7 +73907,7 @@ Fields
Example
{
- "default": "xyz789",
+ "default": "abc123",
"options": [SortField]
}
@@ -75711,11 +74666,6 @@ Fields
Indicates if gift wrapping prices are displayed on the Shopping Cart page. Possible values: 1 (Yes) and 0 (No).
cart_merge_preference - String!
- cart_printed_card - String
Fields
graphql_share_customer_group - Boolean
+ graphql_share_all_customer_groups - Boolean!
+ graphql_share_customer_group - Boolean!
Fields
share_active_segments - Boolean
+ share_all_catalog_rules - Boolean!
+ share_all_sales_rule - Boolean!
+ share_applied_catalog_rules - Boolean!
share_applied_cart_rule - Boolean
+ share_applied_sales_rule - Boolean!
shopping_cart_display_full_summary - Boolean
@@ -76464,41 +75429,41 @@ Fields
Example
{
- "absolute_footer": "abc123",
- "allow_gift_receipt": "abc123",
+ "absolute_footer": "xyz789",
+ "allow_gift_receipt": "xyz789",
"allow_gift_wrapping_on_order": "abc123",
- "allow_gift_wrapping_on_order_items": "abc123",
- "allow_guests_to_write_product_reviews": "xyz789",
- "allow_items": "abc123",
+ "allow_gift_wrapping_on_order_items": "xyz789",
+ "allow_guests_to_write_product_reviews": "abc123",
+ "allow_items": "xyz789",
"allow_order": "abc123",
- "allow_printed_card": "xyz789",
- "autocomplete_on_storefront": true,
+ "allow_printed_card": "abc123",
+ "autocomplete_on_storefront": false,
"base_currency_code": "xyz789",
"base_link_url": "xyz789",
"base_media_url": "abc123",
"base_static_url": "xyz789",
- "base_url": "xyz789",
- "braintree_3dsecure_allowspecific": true,
+ "base_url": "abc123",
+ "braintree_3dsecure_allowspecific": false,
"braintree_3dsecure_always_request_3ds": false,
"braintree_3dsecure_specificcountry": "abc123",
"braintree_3dsecure_threshold_amount": "abc123",
- "braintree_3dsecure_verify_3dsecure": false,
+ "braintree_3dsecure_verify_3dsecure": true,
"braintree_ach_direct_debit_vault_active": true,
- "braintree_applepay_merchant_name": "abc123",
+ "braintree_applepay_merchant_name": "xyz789",
"braintree_applepay_vault_active": false,
"braintree_cc_vault_active": "abc123",
"braintree_cc_vault_cvv": true,
"braintree_environment": "xyz789",
- "braintree_googlepay_btn_color": "abc123",
+ "braintree_googlepay_btn_color": "xyz789",
"braintree_googlepay_cctypes": "xyz789",
"braintree_googlepay_merchant_id": "xyz789",
- "braintree_googlepay_vault_active": true,
+ "braintree_googlepay_vault_active": false,
"braintree_local_payment_allowed_methods": "xyz789",
"braintree_local_payment_fallback_button_text": "abc123",
- "braintree_local_payment_redirect_on_fail": "abc123",
- "braintree_merchant_account_id": "abc123",
+ "braintree_local_payment_redirect_on_fail": "xyz789",
+ "braintree_merchant_account_id": "xyz789",
"braintree_paypal_button_location_cart_type_credit_color": "xyz789",
- "braintree_paypal_button_location_cart_type_credit_label": "abc123",
+ "braintree_paypal_button_location_cart_type_credit_label": "xyz789",
"braintree_paypal_button_location_cart_type_credit_shape": "abc123",
"braintree_paypal_button_location_cart_type_credit_show": true,
"braintree_paypal_button_location_cart_type_messaging_layout": "abc123",
@@ -76507,150 +75472,150 @@ Example
"braintree_paypal_button_location_cart_type_messaging_show": true,
"braintree_paypal_button_location_cart_type_messaging_text_color": "xyz789",
"braintree_paypal_button_location_cart_type_paylater_color": "xyz789",
- "braintree_paypal_button_location_cart_type_paylater_label": "abc123",
+ "braintree_paypal_button_location_cart_type_paylater_label": "xyz789",
"braintree_paypal_button_location_cart_type_paylater_shape": "abc123",
"braintree_paypal_button_location_cart_type_paylater_show": true,
- "braintree_paypal_button_location_cart_type_paypal_color": "xyz789",
- "braintree_paypal_button_location_cart_type_paypal_label": "xyz789",
+ "braintree_paypal_button_location_cart_type_paypal_color": "abc123",
+ "braintree_paypal_button_location_cart_type_paypal_label": "abc123",
"braintree_paypal_button_location_cart_type_paypal_shape": "abc123",
- "braintree_paypal_button_location_cart_type_paypal_show": false,
- "braintree_paypal_button_location_checkout_type_credit_color": "abc123",
- "braintree_paypal_button_location_checkout_type_credit_label": "xyz789",
- "braintree_paypal_button_location_checkout_type_credit_shape": "abc123",
+ "braintree_paypal_button_location_cart_type_paypal_show": true,
+ "braintree_paypal_button_location_checkout_type_credit_color": "xyz789",
+ "braintree_paypal_button_location_checkout_type_credit_label": "abc123",
+ "braintree_paypal_button_location_checkout_type_credit_shape": "xyz789",
"braintree_paypal_button_location_checkout_type_credit_show": false,
- "braintree_paypal_button_location_checkout_type_messaging_layout": "xyz789",
- "braintree_paypal_button_location_checkout_type_messaging_logo": "xyz789",
+ "braintree_paypal_button_location_checkout_type_messaging_layout": "abc123",
+ "braintree_paypal_button_location_checkout_type_messaging_logo": "abc123",
"braintree_paypal_button_location_checkout_type_messaging_logo_position": "xyz789",
- "braintree_paypal_button_location_checkout_type_messaging_show": true,
+ "braintree_paypal_button_location_checkout_type_messaging_show": false,
"braintree_paypal_button_location_checkout_type_messaging_text_color": "abc123",
"braintree_paypal_button_location_checkout_type_paylater_color": "xyz789",
- "braintree_paypal_button_location_checkout_type_paylater_label": "abc123",
+ "braintree_paypal_button_location_checkout_type_paylater_label": "xyz789",
"braintree_paypal_button_location_checkout_type_paylater_shape": "xyz789",
"braintree_paypal_button_location_checkout_type_paylater_show": false,
"braintree_paypal_button_location_checkout_type_paypal_color": "xyz789",
"braintree_paypal_button_location_checkout_type_paypal_label": "xyz789",
- "braintree_paypal_button_location_checkout_type_paypal_shape": "abc123",
+ "braintree_paypal_button_location_checkout_type_paypal_shape": "xyz789",
"braintree_paypal_button_location_checkout_type_paypal_show": true,
- "braintree_paypal_button_location_productpage_type_credit_color": "abc123",
+ "braintree_paypal_button_location_productpage_type_credit_color": "xyz789",
"braintree_paypal_button_location_productpage_type_credit_label": "abc123",
- "braintree_paypal_button_location_productpage_type_credit_shape": "xyz789",
+ "braintree_paypal_button_location_productpage_type_credit_shape": "abc123",
"braintree_paypal_button_location_productpage_type_credit_show": false,
- "braintree_paypal_button_location_productpage_type_messaging_layout": "abc123",
+ "braintree_paypal_button_location_productpage_type_messaging_layout": "xyz789",
"braintree_paypal_button_location_productpage_type_messaging_logo": "abc123",
"braintree_paypal_button_location_productpage_type_messaging_logo_position": "xyz789",
- "braintree_paypal_button_location_productpage_type_messaging_show": true,
- "braintree_paypal_button_location_productpage_type_messaging_text_color": "xyz789",
+ "braintree_paypal_button_location_productpage_type_messaging_show": false,
+ "braintree_paypal_button_location_productpage_type_messaging_text_color": "abc123",
"braintree_paypal_button_location_productpage_type_paylater_color": "abc123",
- "braintree_paypal_button_location_productpage_type_paylater_label": "abc123",
+ "braintree_paypal_button_location_productpage_type_paylater_label": "xyz789",
"braintree_paypal_button_location_productpage_type_paylater_shape": "abc123",
- "braintree_paypal_button_location_productpage_type_paylater_show": true,
+ "braintree_paypal_button_location_productpage_type_paylater_show": false,
"braintree_paypal_button_location_productpage_type_paypal_color": "abc123",
"braintree_paypal_button_location_productpage_type_paypal_label": "abc123",
- "braintree_paypal_button_location_productpage_type_paypal_shape": "abc123",
- "braintree_paypal_button_location_productpage_type_paypal_show": false,
+ "braintree_paypal_button_location_productpage_type_paypal_shape": "xyz789",
+ "braintree_paypal_button_location_productpage_type_paypal_show": true,
"braintree_paypal_credit_uk_merchant_name": "abc123",
- "braintree_paypal_display_on_shopping_cart": true,
- "braintree_paypal_merchant_country": "abc123",
+ "braintree_paypal_display_on_shopping_cart": false,
+ "braintree_paypal_merchant_country": "xyz789",
"braintree_paypal_merchant_name_override": "xyz789",
- "braintree_paypal_require_billing_address": true,
+ "braintree_paypal_require_billing_address": false,
"braintree_paypal_send_cart_line_items": true,
"braintree_paypal_vault_active": false,
- "cart_expires_in_days": 123,
- "cart_gift_wrapping": "abc123",
- "cart_merge_preference": "abc123",
- "cart_printed_card": "abc123",
- "cart_summary_display_quantity": 987,
- "catalog_default_sort_by": "xyz789",
+ "cart_expires_in_days": 987,
+ "cart_gift_wrapping": "xyz789",
+ "cart_printed_card": "xyz789",
+ "cart_summary_display_quantity": 123,
+ "catalog_default_sort_by": "abc123",
"category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
"category_url_suffix": "xyz789",
- "check_money_order_enable_for_specific_countries": true,
+ "check_money_order_enable_for_specific_countries": false,
"check_money_order_enabled": false,
"check_money_order_make_check_payable_to": "xyz789",
"check_money_order_max_order_total": "abc123",
"check_money_order_min_order_total": "xyz789",
- "check_money_order_new_order_status": "abc123",
- "check_money_order_payment_from_specific_countries": "abc123",
+ "check_money_order_new_order_status": "xyz789",
+ "check_money_order_payment_from_specific_countries": "xyz789",
"check_money_order_send_check_to": "abc123",
"check_money_order_sort_order": 987,
- "check_money_order_title": "abc123",
- "cms_home_page": "abc123",
- "cms_no_cookies": "abc123",
- "cms_no_route": "abc123",
+ "check_money_order_title": "xyz789",
+ "cms_home_page": "xyz789",
+ "cms_no_cookies": "xyz789",
+ "cms_no_route": "xyz789",
"code": "xyz789",
"configurable_product_image": "ITSELF",
"configurable_thumbnail_source": "abc123",
- "contact_enabled": false,
+ "contact_enabled": true,
"copyright": "xyz789",
- "countries_with_required_region": "abc123",
+ "countries_with_required_region": "xyz789",
"create_account_confirmation": true,
"customer_access_token_lifetime": 987.65,
- "default_country": "abc123",
- "default_description": "xyz789",
+ "default_country": "xyz789",
+ "default_description": "abc123",
"default_display_currency_code": "abc123",
- "default_keywords": "abc123",
- "default_title": "abc123",
- "demonotice": 987,
+ "default_keywords": "xyz789",
+ "default_title": "xyz789",
+ "demonotice": 123,
"display_product_prices_in_catalog": 123,
- "display_shipping_prices": 123,
- "display_state_if_optional": true,
- "enable_multiple_wishlists": "xyz789",
+ "display_shipping_prices": 987,
+ "display_state_if_optional": false,
+ "enable_multiple_wishlists": "abc123",
"fixed_product_taxes_apply_tax_to_fpt": false,
- "fixed_product_taxes_display_prices_in_emails": 123,
+ "fixed_product_taxes_display_prices_in_emails": 987,
"fixed_product_taxes_display_prices_in_product_lists": 123,
"fixed_product_taxes_display_prices_in_sales_modules": 987,
"fixed_product_taxes_display_prices_on_product_view_page": 987,
"fixed_product_taxes_enable": true,
"fixed_product_taxes_include_fpt_in_subtotal": true,
- "front": "xyz789",
- "graphql_share_customer_group": true,
- "grid_per_page": 123,
- "grid_per_page_values": "abc123",
+ "front": "abc123",
+ "graphql_share_all_customer_groups": true,
+ "graphql_share_customer_group": false,
+ "grid_per_page": 987,
+ "grid_per_page_values": "xyz789",
"grouped_product_image": "ITSELF",
"head_includes": "abc123",
- "head_shortcut_icon": "abc123",
+ "head_shortcut_icon": "xyz789",
"header_logo_src": "xyz789",
- "id": 123,
- "is_checkout_agreements_enabled": false,
- "is_default_store": true,
- "is_default_store_group": false,
+ "id": 987,
+ "is_checkout_agreements_enabled": true,
+ "is_default_store": false,
+ "is_default_store_group": true,
"is_guest_checkout_enabled": true,
"is_negotiable_quote_active": false,
- "is_one_page_checkout_enabled": false,
- "is_requisition_list_active": "abc123",
+ "is_one_page_checkout_enabled": true,
+ "is_requisition_list_active": "xyz789",
"list_mode": "xyz789",
- "list_per_page": 987,
- "list_per_page_values": "abc123",
- "locale": "abc123",
+ "list_per_page": 123,
+ "list_per_page_values": "xyz789",
+ "locale": "xyz789",
"logo_alt": "xyz789",
"logo_height": 123,
- "logo_width": 123,
- "magento_reward_general_is_enabled": "abc123",
- "magento_reward_general_is_enabled_on_front": "xyz789",
+ "logo_width": 987,
+ "magento_reward_general_is_enabled": "xyz789",
+ "magento_reward_general_is_enabled_on_front": "abc123",
"magento_reward_general_min_points_balance": "xyz789",
- "magento_reward_general_publish_history": "xyz789",
+ "magento_reward_general_publish_history": "abc123",
"magento_reward_points_invitation_customer": "xyz789",
- "magento_reward_points_invitation_customer_limit": "xyz789",
+ "magento_reward_points_invitation_customer_limit": "abc123",
"magento_reward_points_invitation_order": "xyz789",
- "magento_reward_points_invitation_order_limit": "xyz789",
+ "magento_reward_points_invitation_order_limit": "abc123",
"magento_reward_points_newsletter": "abc123",
- "magento_reward_points_order": "abc123",
+ "magento_reward_points_order": "xyz789",
"magento_reward_points_register": "xyz789",
"magento_reward_points_review": "abc123",
"magento_reward_points_review_limit": "xyz789",
- "magento_wishlist_general_is_enabled": "abc123",
- "max_items_in_order_summary": 987,
- "maximum_number_of_wishlists": "xyz789",
+ "magento_wishlist_general_is_enabled": "xyz789",
+ "max_items_in_order_summary": 123,
+ "maximum_number_of_wishlists": "abc123",
"minicart_display": false,
"minicart_max_items": 123,
- "minimum_password_length": "xyz789",
+ "minimum_password_length": "abc123",
"newsletter_enabled": true,
"no_route": "xyz789",
- "optional_zip_countries": "abc123",
- "order_cancellation_enabled": false,
+ "optional_zip_countries": "xyz789",
+ "order_cancellation_enabled": true,
"order_cancellation_reasons": [CancellationReason],
"orders_invoices_credit_memos_display_full_summary": false,
"orders_invoices_credit_memos_display_grandtotal": false,
- "orders_invoices_credit_memos_display_price": 987,
+ "orders_invoices_credit_memos_display_price": 123,
"orders_invoices_credit_memos_display_shipping_amount": 987,
"orders_invoices_credit_memos_display_subtotal": 987,
"orders_invoices_credit_memos_display_zero_tax": true,
@@ -76658,47 +75623,49 @@ Example
"printed_card_price": "abc123",
"printed_card_priceV2": Money,
"product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
- "product_reviews_enabled": "xyz789",
- "product_url_suffix": "abc123",
- "quickorder_active": true,
+ "product_reviews_enabled": "abc123",
+ "product_url_suffix": "xyz789",
+ "quickorder_active": false,
"required_character_classes_number": "xyz789",
- "returns_enabled": "abc123",
+ "returns_enabled": "xyz789",
"root_category_id": 123,
"root_category_uid": "4",
"sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
"sales_gift_wrapping": "xyz789",
"sales_printed_card": "xyz789",
"secure_base_link_url": "abc123",
- "secure_base_media_url": "abc123",
- "secure_base_static_url": "xyz789",
+ "secure_base_media_url": "xyz789",
+ "secure_base_static_url": "abc123",
"secure_base_url": "abc123",
"send_friend": SendFriendConfiguration,
- "share_active_segments": true,
- "share_applied_cart_rule": true,
- "shopping_cart_display_full_summary": false,
- "shopping_cart_display_grand_total": false,
+ "share_all_catalog_rules": false,
+ "share_all_sales_rule": true,
+ "share_applied_catalog_rules": true,
+ "share_applied_sales_rule": false,
+ "shopping_cart_display_full_summary": true,
+ "shopping_cart_display_grand_total": true,
"shopping_cart_display_price": 987,
- "shopping_cart_display_shipping": 123,
+ "shopping_cart_display_shipping": 987,
"shopping_cart_display_subtotal": 123,
"shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX",
"shopping_cart_display_zero_tax": true,
"show_cms_breadcrumbs": 987,
- "store_code": "4",
+ "store_code": 4,
"store_group_code": "4",
- "store_group_name": "abc123",
- "store_name": "xyz789",
- "store_sort_order": 987,
+ "store_group_name": "xyz789",
+ "store_name": "abc123",
+ "store_sort_order": 123,
"timezone": "abc123",
"title_prefix": "xyz789",
"title_separator": "xyz789",
"title_suffix": "xyz789",
"use_store_in_url": true,
- "website_code": "4",
- "website_id": 123,
+ "website_code": 4,
+ "website_id": 987,
"website_name": "xyz789",
- "weight_unit": "abc123",
+ "weight_unit": "xyz789",
"welcome": "abc123",
- "zero_subtotal_enable_for_specific_countries": true,
+ "zero_subtotal_enable_for_specific_countries": false,
"zero_subtotal_enabled": false,
"zero_subtotal_new_order_status": "xyz789",
"zero_subtotal_payment_action": "xyz789",
@@ -76765,9 +75732,9 @@ Fields
Example
{
- "position": 987,
+ "position": 123,
"use_in_layered_navigation": "NO",
- "use_in_product_listing": false,
+ "use_in_product_listing": true,
"use_in_search_results_layered_navigation": true,
"visible_on_catalog_pages": true
}
@@ -76862,10 +75829,10 @@ Fields
Example
{
- "comment": "abc123",
+ "comment": "xyz789",
"max_order_commitment": 123,
"min_order_commitment": 987,
- "name": "abc123",
+ "name": "xyz789",
"reference_document_links": [
NegotiableQuoteTemplateReferenceDocumentLinkInput
],
@@ -77016,8 +75983,8 @@ Fields
Example
{
- "type": "abc123",
- "value": "abc123"
+ "type": "xyz789",
+ "value": "xyz789"
}
@@ -77080,7 +76047,7 @@ Possible Types
Example
- {"value": "xyz789"}
+ {"value": "abc123"}
@@ -77397,7 +76364,7 @@ Fields
Example
{
- "cartId": "abc123",
+ "cartId": "xyz789",
"id": "abc123"
}
@@ -77450,8 +76417,8 @@ Fields
Example
{
"amount": Money,
- "rate": 123.45,
- "title": "xyz789"
+ "rate": 987.65,
+ "title": "abc123"
}
@@ -77645,7 +76612,7 @@ Example
{
"discount": ProductDiscount,
"final_price": Money,
- "quantity": 123.45
+ "quantity": 987.65
}
@@ -77693,7 +76660,7 @@ Fields
Example
{
- "cart_id": "abc123",
+ "cart_id": "xyz789",
"cart_items": [CartItemUpdateInput]
}
@@ -78012,7 +76979,7 @@ Example
GiftRegistryDynamicAttributeInput
],
"event_name": "abc123",
- "message": "xyz789",
+ "message": "abc123",
"privacy_settings": "PRIVATE",
"shipping_address": GiftRegistryShippingAddressInput,
"status": "ACTIVE"
@@ -78069,9 +77036,9 @@ Fields
Example
{
- "gift_registry_item_uid": "4",
+ "gift_registry_item_uid": 4,
"note": "xyz789",
- "quantity": 123.45
+ "quantity": 987.65
}
@@ -78219,9 +77186,9 @@ Example
GiftRegistryDynamicAttributeInput
],
"email": "abc123",
- "firstname": "xyz789",
+ "firstname": "abc123",
"gift_registry_registrant_uid": "4",
- "lastname": "abc123"
+ "lastname": "xyz789"
}
@@ -78436,7 +77403,7 @@ Fields
Example
{
"items": [NegotiableQuoteTemplateItemQuantityInput],
- "template_id": "4"
+ "template_id": 4
}
@@ -78561,11 +77528,11 @@ Fields
Example
{
- "applies_to": ["4"],
+ "applies_to": [4],
"approvers": [4],
"condition": CreatePurchaseOrderApprovalRuleConditionInput,
"description": "xyz789",
- "name": "abc123",
+ "name": "xyz789",
"status": "ENABLED",
"uid": 4
}
@@ -78615,7 +77582,7 @@ Fields
Example
{
- "description": "abc123",
+ "description": "xyz789",
"name": "abc123"
}
@@ -78678,7 +77645,7 @@ Example
{
"entered_options": [EnteredOptionInput],
"item_id": "4",
- "quantity": 987.65,
+ "quantity": 123.45,
"selected_options": ["xyz789"]
}
@@ -78808,7 +77775,7 @@ Fields
Example
{
- "name": "xyz789",
+ "name": "abc123",
"uid": 4,
"visibility": "PUBLIC"
}
@@ -78857,7 +77824,7 @@ Fields
Example
{
"parameters": [HttpQueryParameter],
- "url": "xyz789"
+ "url": "abc123"
}
@@ -79021,7 +77988,7 @@ Fields
Example
{
- "currentPage": 123,
+ "currentPage": 987,
"pageSize": 123,
"sort": [CompaniesSortInput]
}
@@ -79558,10 +78525,10 @@ Fields
Example
{
- "payment_source": "abc123",
- "payments_order_id": "abc123",
- "paypal_order_id": "abc123",
- "public_hash": "xyz789"
+ "payment_source": "xyz789",
+ "payments_order_id": "xyz789",
+ "paypal_order_id": "xyz789",
+ "public_hash": "abc123"
}
@@ -79642,7 +78609,7 @@ Fields
Example
- {"public_hash": "abc123"}
+ {"public_hash": "xyz789"}
@@ -79753,10 +78720,10 @@ Example
"discount": [Discount],
"errors": [CartItemError],
"id": "xyz789",
- "is_available": true,
- "max_qty": 987.65,
- "min_qty": 987.65,
- "not_available_message": "xyz789",
+ "is_available": false,
+ "max_qty": 123.45,
+ "min_qty": 123.45,
+ "not_available_message": "abc123",
"note_from_buyer": [ItemNote],
"note_from_seller": [ItemNote],
"prices": CartItemPrices,
@@ -80128,6 +79095,11 @@ currentPage
rules - [CatalogRule]
+ sale - Int
currentPageExample
{
"activity": "abc123",
- "attribute_set_id": 987,
+ "attribute_set_id": 123,
"canonical_url": "abc123",
"categories": [CategoryInterface],
- "category_gear": "xyz789",
+ "category_gear": "abc123",
"climate": "abc123",
"collar": "xyz789",
- "color": 987,
- "country_of_manufacture": "abc123",
+ "color": 123,
+ "country_of_manufacture": "xyz789",
"created_at": "xyz789",
"crosssell_products": [ProductInterface],
"custom_attributesV2": ProductCustomAttributes,
"description": ComplexTextValue,
- "eco_collection": 123,
+ "eco_collection": 987,
"erin_recommends": 987,
"features_bags": "xyz789",
"format": 987,
"gender": "abc123",
- "gift_message_available": false,
+ "gift_message_available": true,
"gift_wrapping_available": false,
"gift_wrapping_price": Money,
"id": 123,
"image": ProductImage,
"is_returnable": "abc123",
"manufacturer": 987,
- "material": "abc123",
- "max_sale_qty": 987.65,
+ "material": "xyz789",
+ "max_sale_qty": 123.45,
"media_gallery": [MediaGalleryInterface],
"media_gallery_entries": [MediaGalleryEntry],
- "meta_description": "xyz789",
+ "meta_description": "abc123",
"meta_keyword": "abc123",
"meta_title": "xyz789",
"min_sale_qty": 987.65,
"name": "xyz789",
"new": 987,
"new_from_date": "abc123",
- "new_to_date": "abc123",
+ "new_to_date": "xyz789",
"only_x_left_in_stock": 123.45,
"options": [CustomizableOptionInterface],
- "options_container": "xyz789",
- "pattern": "abc123",
+ "options_container": "abc123",
+ "pattern": "xyz789",
"performance_fabric": 987,
"price": ProductPrices,
"price_range": PriceRange,
@@ -80355,20 +79327,21 @@ Example
"redirect_code": 987,
"related_products": [ProductInterface],
"relative_url": "abc123",
- "review_count": 123,
+ "review_count": 987,
"reviews": ProductReviews,
+ "rules": [CatalogRule],
"sale": 987,
"short_description": ComplexTextValue,
"size": 123,
- "sku": "xyz789",
+ "sku": "abc123",
"sleeve": "xyz789",
"small_image": ProductImage,
"special_from_date": "xyz789",
"special_price": 987.65,
- "special_to_date": "abc123",
+ "special_to_date": "xyz789",
"staged": true,
"stock_status": "IN_STOCK",
- "strap_bags": "abc123",
+ "strap_bags": "xyz789",
"style_bags": "xyz789",
"style_bottom": "xyz789",
"style_general": "abc123",
@@ -80378,8 +79351,8 @@ Example
"tier_prices": [ProductTierPrices],
"type": "CMS_PAGE",
"type_id": "xyz789",
- "uid": 4,
- "updated_at": "abc123",
+ "uid": "4",
+ "updated_at": "xyz789",
"upsell_products": [ProductInterface],
"url_key": "xyz789",
"url_path": "xyz789",
@@ -80493,7 +79466,7 @@ Example
"customizable_options": [SelectedCustomizableOption],
"product": ProductInterface,
"quantity": 123.45,
- "uid": 4
+ "uid": "4"
}
@@ -80561,7 +79534,7 @@ Example
{
"added_at": "abc123",
"customizable_options": [SelectedCustomizableOption],
- "description": "abc123",
+ "description": "xyz789",
"id": "4",
"product": ProductInterface,
"quantity": 987.65
@@ -80641,7 +79614,7 @@ Example
"id": 123,
"is_default": true,
"name": "xyz789",
- "sort_order": 123
+ "sort_order": 987
}
@@ -80835,9 +79808,9 @@ Example
"items": [WishlistItem],
"items_count": 987,
"items_v2": WishlistItems,
- "name": "xyz789",
- "sharing_code": "abc123",
- "updated_at": "xyz789",
+ "name": "abc123",
+ "sharing_code": "xyz789",
+ "updated_at": "abc123",
"visibility": "PUBLIC"
}
@@ -80895,8 +79868,8 @@ Fields
Example
{
"code": "PRODUCT_NOT_FOUND",
- "message": "xyz789",
- "wishlistId": 4,
+ "message": "abc123",
+ "wishlistId": "4",
"wishlistItemId": 4
}
@@ -80932,13 +79905,6 @@ Values
{
"activity": "abc123",
- "attribute_set_id": 987,
+ "attribute_set_id": 123,
"canonical_url": "abc123",
"categories": [CategoryInterface],
- "category_gear": "xyz789",
+ "category_gear": "abc123",
"climate": "abc123",
"collar": "xyz789",
- "color": 987,
- "country_of_manufacture": "abc123",
+ "color": 123,
+ "country_of_manufacture": "xyz789",
"created_at": "xyz789",
"crosssell_products": [ProductInterface],
"custom_attributesV2": ProductCustomAttributes,
"description": ComplexTextValue,
- "eco_collection": 123,
+ "eco_collection": 987,
"erin_recommends": 987,
"features_bags": "xyz789",
"format": 987,
"gender": "abc123",
- "gift_message_available": false,
+ "gift_message_available": true,
"gift_wrapping_available": false,
"gift_wrapping_price": Money,
"id": 123,
"image": ProductImage,
"is_returnable": "abc123",
"manufacturer": 987,
- "material": "abc123",
- "max_sale_qty": 987.65,
+ "material": "xyz789",
+ "max_sale_qty": 123.45,
"media_gallery": [MediaGalleryInterface],
"media_gallery_entries": [MediaGalleryEntry],
- "meta_description": "xyz789",
+ "meta_description": "abc123",
"meta_keyword": "abc123",
"meta_title": "xyz789",
"min_sale_qty": 987.65,
"name": "xyz789",
"new": 987,
"new_from_date": "abc123",
- "new_to_date": "abc123",
+ "new_to_date": "xyz789",
"only_x_left_in_stock": 123.45,
"options": [CustomizableOptionInterface],
- "options_container": "xyz789",
- "pattern": "abc123",
+ "options_container": "abc123",
+ "pattern": "xyz789",
"performance_fabric": 987,
"price": ProductPrices,
"price_range": PriceRange,
@@ -80355,20 +79327,21 @@ Example
"redirect_code": 987,
"related_products": [ProductInterface],
"relative_url": "abc123",
- "review_count": 123,
+ "review_count": 987,
"reviews": ProductReviews,
+ "rules": [CatalogRule],
"sale": 987,
"short_description": ComplexTextValue,
"size": 123,
- "sku": "xyz789",
+ "sku": "abc123",
"sleeve": "xyz789",
"small_image": ProductImage,
"special_from_date": "xyz789",
"special_price": 987.65,
- "special_to_date": "abc123",
+ "special_to_date": "xyz789",
"staged": true,
"stock_status": "IN_STOCK",
- "strap_bags": "abc123",
+ "strap_bags": "xyz789",
"style_bags": "xyz789",
"style_bottom": "xyz789",
"style_general": "abc123",
@@ -80378,8 +79351,8 @@ Example
"tier_prices": [ProductTierPrices],
"type": "CMS_PAGE",
"type_id": "xyz789",
- "uid": 4,
- "updated_at": "abc123",
+ "uid": "4",
+ "updated_at": "xyz789",
"upsell_products": [ProductInterface],
"url_key": "xyz789",
"url_path": "xyz789",
@@ -80493,7 +79466,7 @@ Example
"customizable_options": [SelectedCustomizableOption],
"product": ProductInterface,
"quantity": 123.45,
- "uid": 4
+ "uid": "4"
}
@@ -80561,7 +79534,7 @@ Example
{
"added_at": "abc123",
"customizable_options": [SelectedCustomizableOption],
- "description": "abc123",
+ "description": "xyz789",
"id": "4",
"product": ProductInterface,
"quantity": 987.65
@@ -80641,7 +79614,7 @@ Example
"id": 123,
"is_default": true,
"name": "xyz789",
- "sort_order": 123
+ "sort_order": 987
}
@@ -80835,9 +79808,9 @@ Example
"items": [WishlistItem], "items_count": 987, "items_v2": WishlistItems, - "name": "xyz789", - "sharing_code": "abc123", - "updated_at": "xyz789", + "name": "abc123", + "sharing_code": "xyz789", + "updated_at": "abc123", "visibility": "PUBLIC" }{
"code": "PRODUCT_NOT_FOUND",
- "message": "xyz789",
- "wishlistId": 4,
+ "message": "abc123",
+ "wishlistId": "4",
"wishlistItemId": 4
}
REQUIRED_PARAMETER_MISSING
NOT_SALABLE
Example
{
"added_at": "xyz789",
"description": "xyz789",
- "id": 123,
+ "id": 987,
"product": ProductInterface,
- "qty": 987.65
+ "qty": 123.45
}
@@ -81147,10 +80113,10 @@ Fields
Example
{
"entered_options": [EnteredOptionInput],
- "parent_sku": "abc123",
- "quantity": 123.45,
- "selected_options": [4],
- "sku": "abc123"
+ "parent_sku": "xyz789",
+ "quantity": 987.65,
+ "selected_options": ["4"],
+ "sku": "xyz789"
}
@@ -81237,12 +80203,12 @@ Possible Types
Possible Types
Example
{
- "added_at": "xyz789",
+ "added_at": "abc123",
"customizable_options": [SelectedCustomizableOption],
- "description": "abc123",
- "id": 4,
+ "description": "xyz789",
+ "id": "4",
"product": ProductInterface,
- "quantity": 987.65
+ "quantity": 123.45
}
Fields
Example
-{"quantity": 123.45, "wishlist_item_id": 4}
+ {
+ "quantity": 987.65,
+ "wishlist_item_id": "4"
+}
Fields
Example
{
- "description": "abc123",
+ "description": "xyz789",
"entered_options": [EnteredOptionInput],
"quantity": 987.65,
- "selected_options": ["4"],
+ "selected_options": [4],
"wishlist_item_id": "4"
}
@@ -81498,10 +80467,10 @@ Fields
Example
{
"items": [WishlistItem],
- "items_count": 987,
+ "items_count": 123,
"name": "xyz789",
"sharing_code": "abc123",
- "updated_at": "xyz789"
+ "updated_at": "abc123"
}
Fields
Example
-{"cart_id": "xyz789"}
+ {"cart_id": "abc123"}
Types
Types
Types
Types
Types
Types
Types
Types
Types
Types
Types
Types
Headers
Version
-2.4.8
+2.4.9
Query
braintree_paypal_vault_active cart_expires_in_days cart_gift_wrapping + cart_merge_preference cart_printed_card cart_summary_display_quantity catalog_default_sort_by @@ -1481,7 +1498,6 @@Query
fixed_product_taxes_enable fixed_product_taxes_include_fpt_in_subtotal front - graphql_share_all_customer_groups graphql_share_customer_group grid_per_page grid_per_page_values @@ -1559,10 +1575,8 @@Query
send_friend { ...SendFriendConfigurationFragment } - share_all_catalog_rules - share_all_sales_rule - share_applied_catalog_rules - share_applied_sales_rule + share_active_segments + share_applied_cart_rule shopping_cart_display_full_summary shopping_cart_display_grand_total shopping_cart_display_price @@ -1599,7 +1613,7 @@Query
Variables
-{"useCurrentGroup": false}
+ {"useCurrentGroup": true}
Response
"availableStores": [ { "absolute_footer": "abc123", - "allow_gift_receipt": "xyz789", - "allow_gift_wrapping_on_order": "xyz789", - "allow_gift_wrapping_on_order_items": "xyz789", - "allow_guests_to_write_product_reviews": "xyz789", - "allow_items": "abc123", + "allow_gift_receipt": "abc123", + "allow_gift_wrapping_on_order": "abc123", + "allow_gift_wrapping_on_order_items": "abc123", + "allow_guests_to_write_product_reviews": "abc123", + "allow_items": "xyz789", "allow_order": "xyz789", - "allow_printed_card": "abc123", - "autocomplete_on_storefront": true, + "allow_printed_card": "xyz789", + "autocomplete_on_storefront": false, "base_currency_code": "abc123", "base_link_url": "abc123", - "base_media_url": "xyz789", - "base_static_url": "xyz789", + "base_media_url": "abc123", + "base_static_url": "abc123", "base_url": "xyz789", "braintree_3dsecure_allowspecific": true, - "braintree_3dsecure_always_request_3ds": false, + "braintree_3dsecure_always_request_3ds": true, "braintree_3dsecure_specificcountry": "xyz789", - "braintree_3dsecure_threshold_amount": "xyz789", + "braintree_3dsecure_threshold_amount": "abc123", "braintree_3dsecure_verify_3dsecure": false, - "braintree_ach_direct_debit_vault_active": false, + "braintree_ach_direct_debit_vault_active": true, "braintree_applepay_merchant_name": "xyz789", "braintree_applepay_vault_active": false, "braintree_cc_vault_active": "xyz789", "braintree_cc_vault_cvv": false, - "braintree_environment": "xyz789", + "braintree_environment": "abc123", "braintree_googlepay_btn_color": "xyz789", "braintree_googlepay_cctypes": "xyz789", - "braintree_googlepay_merchant_id": "abc123", + "braintree_googlepay_merchant_id": "xyz789", "braintree_googlepay_vault_active": false, - "braintree_local_payment_allowed_methods": "abc123", + "braintree_local_payment_allowed_methods": "xyz789", "braintree_local_payment_fallback_button_text": "abc123", - "braintree_local_payment_redirect_on_fail": "xyz789", + "braintree_local_payment_redirect_on_fail": "abc123", "braintree_merchant_account_id": "abc123", - "braintree_paypal_button_location_cart_type_credit_color": "xyz789", - "braintree_paypal_button_location_cart_type_credit_label": "abc123", + "braintree_paypal_button_location_cart_type_credit_color": "abc123", + "braintree_paypal_button_location_cart_type_credit_label": "xyz789", "braintree_paypal_button_location_cart_type_credit_shape": "xyz789", "braintree_paypal_button_location_cart_type_credit_show": true, - "braintree_paypal_button_location_cart_type_messaging_layout": "abc123", - "braintree_paypal_button_location_cart_type_messaging_logo": "xyz789", - "braintree_paypal_button_location_cart_type_messaging_logo_position": "abc123", - "braintree_paypal_button_location_cart_type_messaging_show": true, - "braintree_paypal_button_location_cart_type_messaging_text_color": "abc123", + "braintree_paypal_button_location_cart_type_messaging_layout": "xyz789", + "braintree_paypal_button_location_cart_type_messaging_logo": "abc123", + "braintree_paypal_button_location_cart_type_messaging_logo_position": "xyz789", + "braintree_paypal_button_location_cart_type_messaging_show": false, + "braintree_paypal_button_location_cart_type_messaging_text_color": "xyz789", "braintree_paypal_button_location_cart_type_paylater_color": "abc123", "braintree_paypal_button_location_cart_type_paylater_label": "xyz789", - "braintree_paypal_button_location_cart_type_paylater_shape": "xyz789", + "braintree_paypal_button_location_cart_type_paylater_shape": "abc123", "braintree_paypal_button_location_cart_type_paylater_show": false, - "braintree_paypal_button_location_cart_type_paypal_color": "xyz789", + "braintree_paypal_button_location_cart_type_paypal_color": "abc123", "braintree_paypal_button_location_cart_type_paypal_label": "xyz789", - "braintree_paypal_button_location_cart_type_paypal_shape": "xyz789", + "braintree_paypal_button_location_cart_type_paypal_shape": "abc123", "braintree_paypal_button_location_cart_type_paypal_show": true, "braintree_paypal_button_location_checkout_type_credit_color": "abc123", "braintree_paypal_button_location_checkout_type_credit_label": "xyz789", "braintree_paypal_button_location_checkout_type_credit_shape": "abc123", "braintree_paypal_button_location_checkout_type_credit_show": false, - "braintree_paypal_button_location_checkout_type_messaging_layout": "xyz789", - "braintree_paypal_button_location_checkout_type_messaging_logo": "xyz789", + "braintree_paypal_button_location_checkout_type_messaging_layout": "abc123", + "braintree_paypal_button_location_checkout_type_messaging_logo": "abc123", "braintree_paypal_button_location_checkout_type_messaging_logo_position": "abc123", - "braintree_paypal_button_location_checkout_type_messaging_show": true, - "braintree_paypal_button_location_checkout_type_messaging_text_color": "abc123", - "braintree_paypal_button_location_checkout_type_paylater_color": "xyz789", - "braintree_paypal_button_location_checkout_type_paylater_label": "xyz789", + "braintree_paypal_button_location_checkout_type_messaging_show": false, + "braintree_paypal_button_location_checkout_type_messaging_text_color": "xyz789", + "braintree_paypal_button_location_checkout_type_paylater_color": "abc123", + "braintree_paypal_button_location_checkout_type_paylater_label": "abc123", "braintree_paypal_button_location_checkout_type_paylater_shape": "abc123", - "braintree_paypal_button_location_checkout_type_paylater_show": true, + "braintree_paypal_button_location_checkout_type_paylater_show": false, "braintree_paypal_button_location_checkout_type_paypal_color": "abc123", - "braintree_paypal_button_location_checkout_type_paypal_label": "abc123", + "braintree_paypal_button_location_checkout_type_paypal_label": "xyz789", "braintree_paypal_button_location_checkout_type_paypal_shape": "xyz789", "braintree_paypal_button_location_checkout_type_paypal_show": true, "braintree_paypal_button_location_productpage_type_credit_color": "abc123", - "braintree_paypal_button_location_productpage_type_credit_label": "xyz789", - "braintree_paypal_button_location_productpage_type_credit_shape": "abc123", - "braintree_paypal_button_location_productpage_type_credit_show": true, - "braintree_paypal_button_location_productpage_type_messaging_layout": "xyz789", + "braintree_paypal_button_location_productpage_type_credit_label": "abc123", + "braintree_paypal_button_location_productpage_type_credit_shape": "xyz789", + "braintree_paypal_button_location_productpage_type_credit_show": false, + "braintree_paypal_button_location_productpage_type_messaging_layout": "abc123", "braintree_paypal_button_location_productpage_type_messaging_logo": "abc123", - "braintree_paypal_button_location_productpage_type_messaging_logo_position": "abc123", + "braintree_paypal_button_location_productpage_type_messaging_logo_position": "xyz789", "braintree_paypal_button_location_productpage_type_messaging_show": true, "braintree_paypal_button_location_productpage_type_messaging_text_color": "abc123", - "braintree_paypal_button_location_productpage_type_paylater_color": "xyz789", - "braintree_paypal_button_location_productpage_type_paylater_label": "abc123", + "braintree_paypal_button_location_productpage_type_paylater_color": "abc123", + "braintree_paypal_button_location_productpage_type_paylater_label": "xyz789", "braintree_paypal_button_location_productpage_type_paylater_shape": "abc123", - "braintree_paypal_button_location_productpage_type_paylater_show": false, + "braintree_paypal_button_location_productpage_type_paylater_show": true, "braintree_paypal_button_location_productpage_type_paypal_color": "xyz789", "braintree_paypal_button_location_productpage_type_paypal_label": "xyz789", "braintree_paypal_button_location_productpage_type_paypal_shape": "abc123", "braintree_paypal_button_location_productpage_type_paypal_show": true, - "braintree_paypal_credit_uk_merchant_name": "abc123", + "braintree_paypal_credit_uk_merchant_name": "xyz789", "braintree_paypal_display_on_shopping_cart": false, - "braintree_paypal_merchant_country": "abc123", - "braintree_paypal_merchant_name_override": "xyz789", + "braintree_paypal_merchant_country": "xyz789", + "braintree_paypal_merchant_name_override": "abc123", "braintree_paypal_require_billing_address": true, - "braintree_paypal_send_cart_line_items": false, - "braintree_paypal_vault_active": true, + "braintree_paypal_send_cart_line_items": true, + "braintree_paypal_vault_active": false, "cart_expires_in_days": 123, - "cart_gift_wrapping": "abc123", - "cart_printed_card": "xyz789", - "cart_summary_display_quantity": 987, + "cart_gift_wrapping": "xyz789", + "cart_merge_preference": "abc123", + "cart_printed_card": "abc123", + "cart_summary_display_quantity": 123, "catalog_default_sort_by": "abc123", "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", "category_url_suffix": "xyz789", - "check_money_order_enable_for_specific_countries": true, + "check_money_order_enable_for_specific_countries": false, "check_money_order_enabled": false, "check_money_order_make_check_payable_to": "abc123", "check_money_order_max_order_total": "xyz789", "check_money_order_min_order_total": "abc123", - "check_money_order_new_order_status": "xyz789", + "check_money_order_new_order_status": "abc123", "check_money_order_payment_from_specific_countries": "abc123", "check_money_order_send_check_to": "abc123", - "check_money_order_sort_order": 987, - "check_money_order_title": "abc123", - "cms_home_page": "xyz789", + "check_money_order_sort_order": 123, + "check_money_order_title": "xyz789", + "cms_home_page": "abc123", "cms_no_cookies": "xyz789", - "cms_no_route": "abc123", + "cms_no_route": "xyz789", "code": "abc123", "configurable_product_image": "ITSELF", "configurable_thumbnail_source": "abc123", @@ -1727,131 +1742,128 @@Response
"countries_with_required_region": "abc123", "create_account_confirmation": false, "customer_access_token_lifetime": 123.45, - "default_country": "xyz789", - "default_description": "abc123", + "default_country": "abc123", + "default_description": "xyz789", "default_display_currency_code": "xyz789", "default_keywords": "xyz789", - "default_title": "xyz789", + "default_title": "abc123", "demonotice": 123, "display_product_prices_in_catalog": 123, - "display_shipping_prices": 123, + "display_shipping_prices": 987, "display_state_if_optional": false, "enable_multiple_wishlists": "xyz789", "fixed_product_taxes_apply_tax_to_fpt": false, "fixed_product_taxes_display_prices_in_emails": 123, "fixed_product_taxes_display_prices_in_product_lists": 987, "fixed_product_taxes_display_prices_in_sales_modules": 123, - "fixed_product_taxes_display_prices_on_product_view_page": 123, + "fixed_product_taxes_display_prices_on_product_view_page": 987, "fixed_product_taxes_enable": true, - "fixed_product_taxes_include_fpt_in_subtotal": false, + "fixed_product_taxes_include_fpt_in_subtotal": true, "front": "xyz789", - "graphql_share_all_customer_groups": false, "graphql_share_customer_group": false, - "grid_per_page": 123, - "grid_per_page_values": "xyz789", + "grid_per_page": 987, + "grid_per_page_values": "abc123", "grouped_product_image": "ITSELF", - "head_includes": "xyz789", + "head_includes": "abc123", "head_shortcut_icon": "abc123", - "header_logo_src": "abc123", - "id": 987, + "header_logo_src": "xyz789", + "id": 123, "is_checkout_agreements_enabled": false, "is_default_store": true, - "is_default_store_group": true, + "is_default_store_group": false, "is_guest_checkout_enabled": true, "is_negotiable_quote_active": true, - "is_one_page_checkout_enabled": true, - "is_requisition_list_active": "xyz789", + "is_one_page_checkout_enabled": false, + "is_requisition_list_active": "abc123", "list_mode": "xyz789", - "list_per_page": 987, - "list_per_page_values": "xyz789", + "list_per_page": 123, + "list_per_page_values": "abc123", "locale": "abc123", - "logo_alt": "xyz789", - "logo_height": 987, + "logo_alt": "abc123", + "logo_height": 123, "logo_width": 123, - "magento_reward_general_is_enabled": "xyz789", + "magento_reward_general_is_enabled": "abc123", "magento_reward_general_is_enabled_on_front": "abc123", "magento_reward_general_min_points_balance": "xyz789", - "magento_reward_general_publish_history": "abc123", - "magento_reward_points_invitation_customer": "abc123", + "magento_reward_general_publish_history": "xyz789", + "magento_reward_points_invitation_customer": "xyz789", "magento_reward_points_invitation_customer_limit": "xyz789", "magento_reward_points_invitation_order": "xyz789", "magento_reward_points_invitation_order_limit": "xyz789", "magento_reward_points_newsletter": "xyz789", - "magento_reward_points_order": "abc123", + "magento_reward_points_order": "xyz789", "magento_reward_points_register": "abc123", "magento_reward_points_review": "xyz789", - "magento_reward_points_review_limit": "abc123", - "magento_wishlist_general_is_enabled": "xyz789", - "max_items_in_order_summary": 123, + "magento_reward_points_review_limit": "xyz789", + "magento_wishlist_general_is_enabled": "abc123", + "max_items_in_order_summary": 987, "maximum_number_of_wishlists": "xyz789", - "minicart_display": false, - "minicart_max_items": 987, - "minimum_password_length": "xyz789", - "newsletter_enabled": false, + "minicart_display": true, + "minicart_max_items": 123, + "minimum_password_length": "abc123", + "newsletter_enabled": true, "no_route": "xyz789", "optional_zip_countries": "abc123", "order_cancellation_enabled": false, "order_cancellation_reasons": [ CancellationReason ], - "orders_invoices_credit_memos_display_full_summary": false, + "orders_invoices_credit_memos_display_full_summary": true, "orders_invoices_credit_memos_display_grandtotal": false, - "orders_invoices_credit_memos_display_price": 123, - "orders_invoices_credit_memos_display_shipping_amount": 987, + "orders_invoices_credit_memos_display_price": 987, + "orders_invoices_credit_memos_display_shipping_amount": 123, "orders_invoices_credit_memos_display_subtotal": 123, "orders_invoices_credit_memos_display_zero_tax": true, - "payment_payflowpro_cc_vault_active": "xyz789", + "payment_payflowpro_cc_vault_active": "abc123", "printed_card_price": "abc123", "printed_card_priceV2": Money, "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", - "product_reviews_enabled": "abc123", - "product_url_suffix": "abc123", - "quickorder_active": true, + "product_reviews_enabled": "xyz789", + "product_url_suffix": "xyz789", + "quickorder_active": false, "required_character_classes_number": "xyz789", "returns_enabled": "xyz789", - "root_category_id": 123, - "root_category_uid": 4, + "root_category_id": 987, + "root_category_uid": "4", "sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", - "sales_gift_wrapping": "abc123", - "sales_printed_card": "xyz789", - "secure_base_link_url": "abc123", + "sales_gift_wrapping": "xyz789", + "sales_printed_card": "abc123", + "secure_base_link_url": "xyz789", "secure_base_media_url": "abc123", - "secure_base_static_url": "xyz789", + "secure_base_static_url": "abc123", "secure_base_url": "xyz789", "send_friend": SendFriendConfiguration, - "share_all_catalog_rules": false, - "share_all_sales_rule": false, - "share_applied_catalog_rules": true, - "share_applied_sales_rule": true, - "shopping_cart_display_full_summary": false, - "shopping_cart_display_grand_total": true, + "share_active_segments": true, + "share_applied_cart_rule": true, + "shopping_cart_display_full_summary": true, + "shopping_cart_display_grand_total": false, "shopping_cart_display_price": 123, "shopping_cart_display_shipping": 123, "shopping_cart_display_subtotal": 987, "shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX", - "shopping_cart_display_zero_tax": true, - "show_cms_breadcrumbs": 987, - "store_code": "4", + "shopping_cart_display_zero_tax": false, + "show_cms_breadcrumbs": 123, + "store_code": 4, "store_group_code": "4", "store_group_name": "xyz789", "store_name": "abc123", - "store_sort_order": 987, + "store_sort_order": 123, "timezone": "abc123", "title_prefix": "xyz789", - "title_separator": "xyz789", + "title_separator": "abc123", "title_suffix": "abc123", "use_store_in_url": false, - "website_code": "4", + "website_code": 4, "website_id": 987, "website_name": "abc123", - "weight_unit": "xyz789", + "weight_unit": "abc123", "welcome": "xyz789", - "zero_subtotal_enable_for_specific_countries": true, + "zero_subtotal_enable_for_specific_countries": false, "zero_subtotal_enabled": true, - "zero_subtotal_new_order_status": "abc123", - "zero_subtotal_payment_action": "xyz789", - "zero_subtotal_payment_from_specific_countries": "abc123", - "zero_subtotal_sort_order": 123, + "zero_subtotal_new_order_status": "xyz789", + "zero_subtotal_payment_action": "abc123", + "zero_subtotal_payment_from_specific_countries": "xyz789", + "zero_subtotal_sort_order": 987, "zero_subtotal_title": "abc123" } ] @@ -1956,7 +1968,7 @@Query
} printed_card_included rules { - ...CartRuleFragment + ...CartRuleStorefrontFragment } selected_payment_method { ...SelectedPaymentMethodFragment @@ -1971,7 +1983,7 @@Query
Variables
-{"cart_id": "abc123"}
+ {"cart_id": "xyz789"}
Response
"billing_address": BillingCartAddress, "email": "abc123", "gift_message": GiftMessage, - "gift_receipt_included": true, + "gift_receipt_included": false, "gift_wrapping": GiftWrapping, "id": "4", - "is_virtual": true, + "is_virtual": false, "items": [CartItemInterface], "itemsV2": CartItems, "prices": CartPrices, "printed_card_included": false, - "rules": [CartRule], + "rules": [CartRuleStorefront], "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], "total_quantity": 123.45 @@ -2223,7 +2235,7 @@Query
Variables
-{"id": 123}
+ {"id": 987}
Response
{
"data": {
"category": {
- "automatic_sorting": "xyz789",
- "available_sort_by": ["abc123"],
+ "automatic_sorting": "abc123",
+ "available_sort_by": ["xyz789"],
"breadcrumbs": [Breadcrumb],
- "canonical_url": "xyz789",
+ "canonical_url": "abc123",
"children": [CategoryTree],
- "children_count": "xyz789",
+ "children_count": "abc123",
"cms_block": CmsBlock,
"created_at": "xyz789",
"custom_layout_update_file": "xyz789",
- "default_sort_by": "abc123",
+ "default_sort_by": "xyz789",
"description": "xyz789",
"display_mode": "xyz789",
"filter_price_range": 987.65,
"id": 987,
"image": "abc123",
- "include_in_menu": 123,
+ "include_in_menu": 987,
"is_anchor": 987,
- "landing_page": 987,
+ "landing_page": 123,
"level": 987,
- "meta_description": "abc123",
+ "meta_description": "xyz789",
"meta_keywords": "xyz789",
"meta_title": "xyz789",
"name": "xyz789",
"path": "xyz789",
- "path_in_store": "xyz789",
+ "path_in_store": "abc123",
"position": 987,
"product_count": 987,
"products": CategoryProducts,
- "redirect_code": 123,
- "relative_url": "abc123",
- "staged": true,
+ "redirect_code": 987,
+ "relative_url": "xyz789",
+ "staged": false,
"type": "CMS_PAGE",
- "uid": "4",
- "updated_at": "xyz789",
- "url_key": "abc123",
+ "uid": 4,
+ "updated_at": "abc123",
+ "url_key": "xyz789",
"url_path": "xyz789",
- "url_suffix": "xyz789"
+ "url_suffix": "abc123"
}
}
}
@@ -2416,32 +2428,32 @@ Response
"data": {
"categoryList": [
{
- "automatic_sorting": "xyz789",
- "available_sort_by": ["xyz789"],
+ "automatic_sorting": "abc123",
+ "available_sort_by": ["abc123"],
"breadcrumbs": [Breadcrumb],
"canonical_url": "abc123",
"children": [CategoryTree],
"children_count": "xyz789",
"cms_block": CmsBlock,
"created_at": "xyz789",
- "custom_layout_update_file": "abc123",
+ "custom_layout_update_file": "xyz789",
"default_sort_by": "xyz789",
- "description": "xyz789",
- "display_mode": "xyz789",
- "filter_price_range": 123.45,
- "id": 987,
+ "description": "abc123",
+ "display_mode": "abc123",
+ "filter_price_range": 987.65,
+ "id": 123,
"image": "xyz789",
"include_in_menu": 123,
- "is_anchor": 123,
- "landing_page": 987,
- "level": 987,
+ "is_anchor": 987,
+ "landing_page": 123,
+ "level": 123,
"meta_description": "abc123",
- "meta_keywords": "xyz789",
- "meta_title": "abc123",
+ "meta_keywords": "abc123",
+ "meta_title": "xyz789",
"name": "abc123",
"path": "xyz789",
"path_in_store": "xyz789",
- "position": 987,
+ "position": 123,
"product_count": 123,
"products": CategoryProducts,
"redirect_code": 987,
@@ -2449,9 +2461,9 @@ Response
"staged": true,
"type": "CMS_PAGE",
"uid": "4",
- "updated_at": "xyz789",
+ "updated_at": "abc123",
"url_key": "abc123",
- "url_path": "xyz789",
+ "url_path": "abc123",
"url_suffix": "xyz789"
}
]
@@ -2509,10 +2521,10 @@ Response
"data": {
"checkoutAgreements": [
{
- "agreement_id": 987,
- "checkbox_text": "abc123",
+ "agreement_id": 123,
+ "checkbox_text": "xyz789",
"content": "xyz789",
- "content_height": "abc123",
+ "content_height": "xyz789",
"is_html": false,
"mode": "AUTO",
"name": "xyz789"
@@ -2673,7 +2685,7 @@ Query
Variables
-{"id": 987, "identifier": "abc123"}
+ {"id": 123, "identifier": "abc123"}
Response
"cmsPage": { "content": "xyz789", "content_heading": "abc123", - "identifier": "abc123", - "meta_description": "xyz789", - "meta_keywords": "xyz789", - "meta_title": "abc123", + "identifier": "xyz789", + "meta_description": "abc123", + "meta_keywords": "abc123", + "meta_title": "xyz789", "page_layout": "xyz789", - "redirect_code": 123, + "redirect_code": 987, "relative_url": "abc123", "title": "xyz789", "type": "CMS_PAGE", @@ -2788,10 +2800,10 @@Response
"credit": CompanyCredit, "credit_history": CompanyCreditHistory, "email": "abc123", - "id": 4, + "id": "4", "legal_address": CompanyLegalAddress, "legal_name": "xyz789", - "name": "xyz789", + "name": "abc123", "payment_methods": ["abc123"], "reseller_id": "xyz789", "role": CompanyRole, @@ -2873,7 +2885,7 @@Query
Variables
-{"uid": 4}
+ {"uid": "4"}
Response
"data": { "compareList": { "attributes": [ComparableAttribute], - "item_count": 123, + "item_count": 987, "items": [ComparableItem], - "uid": 4 + "uid": "4" } } } @@ -2944,8 +2956,8 @@Response
"available_regions": [Region], "full_name_english": "xyz789", "full_name_locale": "abc123", - "id": "xyz789", - "three_letter_abbreviation": "abc123", + "id": "abc123", + "three_letter_abbreviation": "xyz789", "two_letter_abbreviation": "xyz789" } ] @@ -3020,7 +3032,7 @@Query
Variables
-{"id": "xyz789"}
+ {"id": "abc123"}
Response
"data": { "country": { "available_regions": [Region], - "full_name_english": "abc123", - "full_name_locale": "abc123", - "id": "xyz789", - "three_letter_abbreviation": "abc123", + "full_name_english": "xyz789", + "full_name_locale": "xyz789", + "id": "abc123", + "three_letter_abbreviation": "xyz789", "two_letter_abbreviation": "xyz789" } } @@ -3094,10 +3106,10 @@Response
"available_currency_codes": [ "abc123" ], - "base_currency_code": "abc123", - "base_currency_symbol": "abc123", + "base_currency_code": "xyz789", + "base_currency_symbol": "xyz789", "default_display_currecy_code": "xyz789", - "default_display_currecy_symbol": "abc123", + "default_display_currecy_symbol": "xyz789", "default_display_currency_code": "abc123", "default_display_currency_symbol": "abc123", "exchange_rates": [ExchangeRate] @@ -3331,7 +3343,7 @@Query
...GiftRegistryFragment } group { - ...CustomerGroupFragment + ...CustomerGroupStorefrontFragment } group_id id @@ -3378,7 +3390,7 @@Query
...CompanyRoleFragment } segments { - ...CustomerSegmentFragment + ...CustomerSegmentStorefrontFragment } status store_credit { @@ -3411,14 +3423,14 @@Response
"customer": { "addresses": [CustomerAddress], "addressesV2": CustomerAddresses, - "allow_remote_shopping_assistance": false, + "allow_remote_shopping_assistance": true, "companies": UserCompaniesOutput, "compare_list": CompareList, "confirmation_status": "ACCOUNT_CONFIRMED", "created_at": "abc123", "custom_attributes": [AttributeValueInterface], - "date_of_birth": "xyz789", - "default_billing": "xyz789", + "date_of_birth": "abc123", + "default_billing": "abc123", "default_shipping": "abc123", "dob": "xyz789", "email": "abc123", @@ -3426,35 +3438,35 @@Response
"gender": 123, "gift_registries": [GiftRegistry], "gift_registry": GiftRegistry, - "group": CustomerGroup, + "group": CustomerGroupStorefront, "group_id": 987, - "id": 987, - "is_subscribed": false, + "id": "4", + "is_subscribed": true, "job_title": "xyz789", - "lastname": "xyz789", + "lastname": "abc123", "middlename": "abc123", "orders": CustomerOrders, - "prefix": "abc123", + "prefix": "xyz789", "purchase_order": PurchaseOrder, "purchase_order_approval_rule": PurchaseOrderApprovalRule, "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata, "purchase_order_approval_rules": PurchaseOrderApprovalRules, "purchase_orders": PurchaseOrders, - "purchase_orders_enabled": true, + "purchase_orders_enabled": false, "requisition_lists": RequisitionLists, "return": Return, "returns": Returns, "reviews": ProductReviews, "reward_points": RewardPoints, "role": CompanyRole, - "segments": [CustomerSegment], + "segments": [CustomerSegmentStorefront], "status": "ACTIVE", "store_credit": CustomerStoreCredit, - "structure_id": "4", + "structure_id": 4, "suffix": "abc123", "taxvat": "abc123", "team": CompanyTeam, - "telephone": "abc123", + "telephone": "xyz789", "wishlist": Wishlist, "wishlist_v2": Wishlist, "wishlists": [Wishlist] @@ -3541,7 +3553,7 @@Query
} printed_card_included rules { - ...CartRuleFragment + ...CartRuleStorefrontFragment } selected_payment_method { ...SelectedPaymentMethodFragment @@ -3574,12 +3586,12 @@Response
"gift_receipt_included": true, "gift_wrapping": GiftWrapping, "id": "4", - "is_virtual": false, + "is_virtual": true, "items": [CartItemInterface], "itemsV2": CartItems, "prices": CartPrices, - "printed_card_included": true, - "rules": [CartRule], + "printed_card_included": false, + "rules": [CartRuleStorefront], "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], "total_quantity": 123.45 @@ -3637,6 +3649,49 @@Response
} } } + +
+ customerGroup
+
+ Description
+Provides Customer Group assigned to the Customer or Guest.
+Response
+ Returns a CustomerGroupStorefront!
+
Example
+Query
+query customerGroup {
+ customerGroup {
+ uid
+ }
+}
+
+ Response
+{"data": {"customerGroup": {"uid": "4"}}}
Response
{
"data": {
"customerOrders": {
- "date_of_first_order": "abc123",
+ "date_of_first_order": "xyz789",
"items": [CustomerOrder],
"page_info": SearchResultPageInfo,
"total_count": 987
@@ -3744,6 +3799,77 @@ Response
"customerPaymentTokens": {"items": [PaymentToken]}
}
}
+
+
+ customerSegments
+
+ Description
+Customer segments associated with the current customer or guest/visitor.
+Response
+ Returns [CustomerSegmentStorefront]
+
Arguments
+| Name | +Description | +
|---|---|
+ cartId - String!
+ |
+ The unique ID of the cart to query. | +
Example
+Query
+query customerSegments($cartId: String!) {
+ customerSegments(cartId: $cartId) {
+ uid
+ }
+}
+
+ Variables
+{"cartId": "abc123"}
+
+ Response
+{
+ "data": {
+ "customerSegments": [{"uid": "4"}]
+ }
+}
Response
"data": { "getPayflowLinkToken": { "mode": "TEST", - "paypal_url": "xyz789", - "secure_token": "abc123", - "secure_token_id": "abc123" + "paypal_url": "abc123", + "secure_token": "xyz789", + "secure_token_id": "xyz789" } } } @@ -4058,6 +4184,9 @@Query
apple_pay { ...ApplePayConfigFragment } + fastlane { + ...FastlaneConfigFragment + } google_pay { ...GooglePayConfigFragment } @@ -4082,6 +4211,7 @@Response
"data": { "getPaymentConfig": { "apple_pay": ApplePayConfig, + "fastlane": FastlaneConfig, "google_pay": GooglePayConfig, "hosted_fields": HostedFieldsConfig, "smart_buttons": SmartButtonsConfig @@ -4167,7 +4297,7 @@Query
Variables
{
- "cartId": "abc123",
+ "cartId": "xyz789",
"id": "abc123"
}
@@ -4469,7 +4599,7 @@ Query
Variables
-{"giftRegistryUid": "4"}
+ {"giftRegistryUid": 4}
Response
"dynamic_attributes": [ GiftRegistryDynamicAttribute ], - "event_name": "xyz789", + "event_name": "abc123", "items": [GiftRegistryItemInterface], - "message": "abc123", + "message": "xyz789", "owner_name": "abc123", "privacy_settings": "PRIVATE", "registrants": [GiftRegistryRegistrant], "shipping_address": CustomerAddress, "status": "ACTIVE", "type": GiftRegistryType, - "uid": 4 + "uid": "4" } } } @@ -4560,7 +4690,7 @@Query
Variables
-{"email": "abc123"}
+ {"email": "xyz789"}
Response
{ "event_date": "xyz789", "event_title": "xyz789", - "gift_registry_uid": "4", - "location": "abc123", - "name": "xyz789", - "type": "xyz789" + "gift_registry_uid": 4, + "location": "xyz789", + "name": "abc123", + "type": "abc123" } ] } @@ -4658,7 +4788,7 @@Response
"event_title": "abc123", "gift_registry_uid": 4, "location": "abc123", - "name": "xyz789", + "name": "abc123", "type": "xyz789" } ] @@ -4752,8 +4882,8 @@Query
Variables
{
"firstName": "abc123",
- "lastName": "xyz789",
- "giftRegistryTypeUid": "4"
+ "lastName": "abc123",
+ "giftRegistryTypeUid": 4
}
Response
"data": { "giftRegistryTypeSearch": [ { - "event_date": "abc123", - "event_title": "xyz789", - "gift_registry_uid": 4, + "event_date": "xyz789", + "event_title": "abc123", + "gift_registry_uid": "4", "location": "abc123", - "name": "abc123", + "name": "xyz789", "type": "xyz789" } ] @@ -4872,7 +5002,7 @@Arguments
input - OrderInformationInput!
+ input - GuestOrderInformationInput!
Arguments
Example
Query
-query guestOrder($input: OrderInformationInput!) {
+ query guestOrder($input: GuestOrderInformationInput!) {
guestOrder(input: $input) {
applied_coupons {
...AppliedCouponFragment
@@ -4958,7 +5088,7 @@ Query
Variables
-{"input": OrderInformationInput}
+ {"input": GuestOrderInformationInput}
Response
"id": 4, "increment_id": "xyz789", "invoices": [Invoice], - "is_virtual": false, + "is_virtual": true, "items": [OrderItemInterface], "items_eligible_for_return": [OrderItemInterface], "number": "xyz789", @@ -4991,11 +5121,11 @@Response
"order_number": "abc123", "order_status_change_date": "xyz789", "payment_methods": [OrderPaymentMethod], - "printed_card_included": true, + "printed_card_included": false, "returns": Returns, "shipments": [OrderShipment], "shipping_address": OrderAddress, - "shipping_method": "abc123", + "shipping_method": "xyz789", "status": "xyz789", "token": "abc123", "total": OrderTotal @@ -5140,32 +5270,32 @@Response
"applied_gift_cards": [ApplyGiftCardToOrder], "available_actions": ["REORDER"], "billing_address": OrderAddress, - "carrier": "abc123", + "carrier": "xyz789", "comments": [SalesCommentItem], - "created_at": "xyz789", + "created_at": "abc123", "credit_memos": [CreditMemo], "customer_info": OrderCustomerInfo, - "email": "abc123", + "email": "xyz789", "gift_message": GiftMessage, "gift_receipt_included": true, "gift_wrapping": GiftWrapping, - "grand_total": 123.45, - "id": "4", - "increment_id": "xyz789", + "grand_total": 987.65, + "id": 4, + "increment_id": "abc123", "invoices": [Invoice], "is_virtual": false, "items": [OrderItemInterface], "items_eligible_for_return": [OrderItemInterface], "number": "xyz789", - "order_date": "xyz789", + "order_date": "abc123", "order_number": "xyz789", "order_status_change_date": "xyz789", "payment_methods": [OrderPaymentMethod], - "printed_card_included": false, + "printed_card_included": true, "returns": Returns, "shipments": [OrderShipment], "shipping_address": OrderAddress, - "shipping_method": "abc123", + "shipping_method": "xyz789", "status": "abc123", "token": "abc123", "total": OrderTotal @@ -5505,7 +5635,7 @@Query
Variables
-{"email": "xyz789"}
+ {"email": "abc123"}
Response
"created_at": "abc123", "email": "abc123", "history": [NegotiableQuoteHistoryEntry], - "is_virtual": false, + "is_virtual": true, "items": [CartItemInterface], "name": "xyz789", "prices": CartPrices, @@ -5743,13 +5873,13 @@Response
"negotiableQuoteTemplate": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "expiration_date": "abc123", + "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], "is_min_max_qty_used": false, "is_virtual": false, "items": [CartItemInterface], - "max_order_commitment": 987, - "min_order_commitment": 123, + "max_order_commitment": 123, + "min_order_commitment": 987, "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, @@ -5760,7 +5890,7 @@Response
NegotiableQuoteShippingAddress ], "status": "abc123", - "template_id": 4, + "template_id": "4", "total_quantity": 123.45 } } @@ -5997,7 +6127,7 @@Response
"items": [NegotiableQuote], "page_info": SearchResultPageInfo, "sort_fields": SortFields, - "total_count": 123 + "total_count": 987 } } } @@ -6129,7 +6259,7 @@Response
"pickupLocations": { "items": [PickupLocation], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } } } @@ -6300,7 +6430,7 @@Query
Variables
{
- "search": "abc123",
+ "search": "xyz789",
"filter": ProductAttributeFilterInput,
"pageSize": 20,
"currentPage": 1,
@@ -6319,7 +6449,7 @@ Response
"page_info": SearchResultPageInfo,
"sort_fields": SortFields,
"suggestions": [SearchSuggestion],
- "total_count": 123
+ "total_count": 987
}
}
}
@@ -6389,7 +6519,7 @@ Response
"data": {
"recaptchaFormConfig": {
"configurations": ReCaptchaConfiguration,
- "is_enabled": false
+ "is_enabled": true
}
}
}
@@ -6445,14 +6575,14 @@ Response
{
"data": {
"recaptchaV3Config": {
- "badge_position": "xyz789",
+ "badge_position": "abc123",
"failure_message": "xyz789",
"forms": ["PLACE_ORDER"],
- "is_enabled": true,
- "language_code": "abc123",
- "minimum_score": 123.45,
+ "is_enabled": false,
+ "language_code": "xyz789",
+ "minimum_score": 987.65,
"theme": "xyz789",
- "website_key": "xyz789"
+ "website_key": "abc123"
}
}
}
@@ -6519,7 +6649,7 @@ Query
Variables
-{"url": "abc123"}
+ {"url": "xyz789"}
Response
{
"data": {
"route": {
- "redirect_code": 987,
+ "redirect_code": 123,
"relative_url": "abc123",
"type": "CMS_PAGE"
}
@@ -6661,6 +6791,7 @@ Query
braintree_paypal_vault_active
cart_expires_in_days
cart_gift_wrapping
+ cart_merge_preference
cart_printed_card
cart_summary_display_quantity
catalog_default_sort_by
@@ -6705,7 +6836,6 @@ Query
fixed_product_taxes_enable
fixed_product_taxes_include_fpt_in_subtotal
front
- graphql_share_all_customer_groups
graphql_share_customer_group
grid_per_page
grid_per_page_values
@@ -6783,10 +6913,8 @@ Query
send_friend {
...SendFriendConfigurationFragment
}
- share_all_catalog_rules
- share_all_sales_rule
- share_applied_catalog_rules
- share_applied_sales_rule
+ share_active_segments
+ share_applied_cart_rule
shopping_cart_display_full_summary
shopping_cart_display_grand_total
shopping_cart_display_price
@@ -6829,246 +6957,244 @@ Response
"absolute_footer": "xyz789",
"allow_gift_receipt": "xyz789",
"allow_gift_wrapping_on_order": "xyz789",
- "allow_gift_wrapping_on_order_items": "xyz789",
- "allow_guests_to_write_product_reviews": "abc123",
- "allow_items": "abc123",
+ "allow_gift_wrapping_on_order_items": "abc123",
+ "allow_guests_to_write_product_reviews": "xyz789",
+ "allow_items": "xyz789",
"allow_order": "abc123",
"allow_printed_card": "xyz789",
"autocomplete_on_storefront": true,
"base_currency_code": "abc123",
- "base_link_url": "abc123",
- "base_media_url": "xyz789",
+ "base_link_url": "xyz789",
+ "base_media_url": "abc123",
"base_static_url": "abc123",
- "base_url": "abc123",
+ "base_url": "xyz789",
"braintree_3dsecure_allowspecific": true,
"braintree_3dsecure_always_request_3ds": false,
"braintree_3dsecure_specificcountry": "xyz789",
- "braintree_3dsecure_threshold_amount": "abc123",
+ "braintree_3dsecure_threshold_amount": "xyz789",
"braintree_3dsecure_verify_3dsecure": false,
"braintree_ach_direct_debit_vault_active": true,
"braintree_applepay_merchant_name": "xyz789",
- "braintree_applepay_vault_active": true,
- "braintree_cc_vault_active": "abc123",
+ "braintree_applepay_vault_active": false,
+ "braintree_cc_vault_active": "xyz789",
"braintree_cc_vault_cvv": false,
"braintree_environment": "abc123",
- "braintree_googlepay_btn_color": "abc123",
- "braintree_googlepay_cctypes": "xyz789",
+ "braintree_googlepay_btn_color": "xyz789",
+ "braintree_googlepay_cctypes": "abc123",
"braintree_googlepay_merchant_id": "abc123",
"braintree_googlepay_vault_active": true,
- "braintree_local_payment_allowed_methods": "abc123",
+ "braintree_local_payment_allowed_methods": "xyz789",
"braintree_local_payment_fallback_button_text": "abc123",
- "braintree_local_payment_redirect_on_fail": "xyz789",
- "braintree_merchant_account_id": "xyz789",
+ "braintree_local_payment_redirect_on_fail": "abc123",
+ "braintree_merchant_account_id": "abc123",
"braintree_paypal_button_location_cart_type_credit_color": "abc123",
"braintree_paypal_button_location_cart_type_credit_label": "abc123",
"braintree_paypal_button_location_cart_type_credit_shape": "xyz789",
"braintree_paypal_button_location_cart_type_credit_show": true,
- "braintree_paypal_button_location_cart_type_messaging_layout": "abc123",
- "braintree_paypal_button_location_cart_type_messaging_logo": "abc123",
+ "braintree_paypal_button_location_cart_type_messaging_layout": "xyz789",
+ "braintree_paypal_button_location_cart_type_messaging_logo": "xyz789",
"braintree_paypal_button_location_cart_type_messaging_logo_position": "abc123",
- "braintree_paypal_button_location_cart_type_messaging_show": true,
+ "braintree_paypal_button_location_cart_type_messaging_show": false,
"braintree_paypal_button_location_cart_type_messaging_text_color": "abc123",
- "braintree_paypal_button_location_cart_type_paylater_color": "abc123",
- "braintree_paypal_button_location_cart_type_paylater_label": "xyz789",
+ "braintree_paypal_button_location_cart_type_paylater_color": "xyz789",
+ "braintree_paypal_button_location_cart_type_paylater_label": "abc123",
"braintree_paypal_button_location_cart_type_paylater_shape": "abc123",
"braintree_paypal_button_location_cart_type_paylater_show": false,
"braintree_paypal_button_location_cart_type_paypal_color": "xyz789",
"braintree_paypal_button_location_cart_type_paypal_label": "abc123",
- "braintree_paypal_button_location_cart_type_paypal_shape": "abc123",
+ "braintree_paypal_button_location_cart_type_paypal_shape": "xyz789",
"braintree_paypal_button_location_cart_type_paypal_show": false,
- "braintree_paypal_button_location_checkout_type_credit_color": "xyz789",
+ "braintree_paypal_button_location_checkout_type_credit_color": "abc123",
"braintree_paypal_button_location_checkout_type_credit_label": "abc123",
- "braintree_paypal_button_location_checkout_type_credit_shape": "abc123",
+ "braintree_paypal_button_location_checkout_type_credit_shape": "xyz789",
"braintree_paypal_button_location_checkout_type_credit_show": true,
- "braintree_paypal_button_location_checkout_type_messaging_layout": "xyz789",
+ "braintree_paypal_button_location_checkout_type_messaging_layout": "abc123",
"braintree_paypal_button_location_checkout_type_messaging_logo": "abc123",
"braintree_paypal_button_location_checkout_type_messaging_logo_position": "abc123",
"braintree_paypal_button_location_checkout_type_messaging_show": true,
- "braintree_paypal_button_location_checkout_type_messaging_text_color": "abc123",
- "braintree_paypal_button_location_checkout_type_paylater_color": "xyz789",
+ "braintree_paypal_button_location_checkout_type_messaging_text_color": "xyz789",
+ "braintree_paypal_button_location_checkout_type_paylater_color": "abc123",
"braintree_paypal_button_location_checkout_type_paylater_label": "xyz789",
- "braintree_paypal_button_location_checkout_type_paylater_shape": "abc123",
- "braintree_paypal_button_location_checkout_type_paylater_show": false,
+ "braintree_paypal_button_location_checkout_type_paylater_shape": "xyz789",
+ "braintree_paypal_button_location_checkout_type_paylater_show": true,
"braintree_paypal_button_location_checkout_type_paypal_color": "xyz789",
- "braintree_paypal_button_location_checkout_type_paypal_label": "abc123",
+ "braintree_paypal_button_location_checkout_type_paypal_label": "xyz789",
"braintree_paypal_button_location_checkout_type_paypal_shape": "abc123",
- "braintree_paypal_button_location_checkout_type_paypal_show": false,
- "braintree_paypal_button_location_productpage_type_credit_color": "abc123",
- "braintree_paypal_button_location_productpage_type_credit_label": "abc123",
- "braintree_paypal_button_location_productpage_type_credit_shape": "xyz789",
+ "braintree_paypal_button_location_checkout_type_paypal_show": true,
+ "braintree_paypal_button_location_productpage_type_credit_color": "xyz789",
+ "braintree_paypal_button_location_productpage_type_credit_label": "xyz789",
+ "braintree_paypal_button_location_productpage_type_credit_shape": "abc123",
"braintree_paypal_button_location_productpage_type_credit_show": true,
- "braintree_paypal_button_location_productpage_type_messaging_layout": "xyz789",
- "braintree_paypal_button_location_productpage_type_messaging_logo": "xyz789",
- "braintree_paypal_button_location_productpage_type_messaging_logo_position": "abc123",
- "braintree_paypal_button_location_productpage_type_messaging_show": true,
+ "braintree_paypal_button_location_productpage_type_messaging_layout": "abc123",
+ "braintree_paypal_button_location_productpage_type_messaging_logo": "abc123",
+ "braintree_paypal_button_location_productpage_type_messaging_logo_position": "xyz789",
+ "braintree_paypal_button_location_productpage_type_messaging_show": false,
"braintree_paypal_button_location_productpage_type_messaging_text_color": "xyz789",
- "braintree_paypal_button_location_productpage_type_paylater_color": "abc123",
- "braintree_paypal_button_location_productpage_type_paylater_label": "xyz789",
+ "braintree_paypal_button_location_productpage_type_paylater_color": "xyz789",
+ "braintree_paypal_button_location_productpage_type_paylater_label": "abc123",
"braintree_paypal_button_location_productpage_type_paylater_shape": "xyz789",
- "braintree_paypal_button_location_productpage_type_paylater_show": false,
+ "braintree_paypal_button_location_productpage_type_paylater_show": true,
"braintree_paypal_button_location_productpage_type_paypal_color": "abc123",
- "braintree_paypal_button_location_productpage_type_paypal_label": "xyz789",
+ "braintree_paypal_button_location_productpage_type_paypal_label": "abc123",
"braintree_paypal_button_location_productpage_type_paypal_shape": "xyz789",
- "braintree_paypal_button_location_productpage_type_paypal_show": true,
- "braintree_paypal_credit_uk_merchant_name": "abc123",
- "braintree_paypal_display_on_shopping_cart": true,
+ "braintree_paypal_button_location_productpage_type_paypal_show": false,
+ "braintree_paypal_credit_uk_merchant_name": "xyz789",
+ "braintree_paypal_display_on_shopping_cart": false,
"braintree_paypal_merchant_country": "abc123",
"braintree_paypal_merchant_name_override": "xyz789",
"braintree_paypal_require_billing_address": false,
- "braintree_paypal_send_cart_line_items": false,
+ "braintree_paypal_send_cart_line_items": true,
"braintree_paypal_vault_active": true,
- "cart_expires_in_days": 987,
+ "cart_expires_in_days": 123,
"cart_gift_wrapping": "abc123",
+ "cart_merge_preference": "abc123",
"cart_printed_card": "xyz789",
- "cart_summary_display_quantity": 123,
- "catalog_default_sort_by": "xyz789",
+ "cart_summary_display_quantity": 987,
+ "catalog_default_sort_by": "abc123",
"category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
- "category_url_suffix": "xyz789",
- "check_money_order_enable_for_specific_countries": false,
- "check_money_order_enabled": true,
- "check_money_order_make_check_payable_to": "xyz789",
- "check_money_order_max_order_total": "abc123",
+ "category_url_suffix": "abc123",
+ "check_money_order_enable_for_specific_countries": true,
+ "check_money_order_enabled": false,
+ "check_money_order_make_check_payable_to": "abc123",
+ "check_money_order_max_order_total": "xyz789",
"check_money_order_min_order_total": "xyz789",
"check_money_order_new_order_status": "abc123",
- "check_money_order_payment_from_specific_countries": "xyz789",
+ "check_money_order_payment_from_specific_countries": "abc123",
"check_money_order_send_check_to": "abc123",
- "check_money_order_sort_order": 987,
+ "check_money_order_sort_order": 123,
"check_money_order_title": "xyz789",
- "cms_home_page": "abc123",
+ "cms_home_page": "xyz789",
"cms_no_cookies": "abc123",
- "cms_no_route": "xyz789",
+ "cms_no_route": "abc123",
"code": "xyz789",
"configurable_product_image": "ITSELF",
- "configurable_thumbnail_source": "abc123",
- "contact_enabled": true,
- "copyright": "abc123",
+ "configurable_thumbnail_source": "xyz789",
+ "contact_enabled": false,
+ "copyright": "xyz789",
"countries_with_required_region": "xyz789",
"create_account_confirmation": false,
"customer_access_token_lifetime": 123.45,
"default_country": "abc123",
- "default_description": "abc123",
- "default_display_currency_code": "xyz789",
- "default_keywords": "abc123",
- "default_title": "abc123",
- "demonotice": 123,
+ "default_description": "xyz789",
+ "default_display_currency_code": "abc123",
+ "default_keywords": "xyz789",
+ "default_title": "xyz789",
+ "demonotice": 987,
"display_product_prices_in_catalog": 123,
"display_shipping_prices": 123,
"display_state_if_optional": false,
- "enable_multiple_wishlists": "xyz789",
+ "enable_multiple_wishlists": "abc123",
"fixed_product_taxes_apply_tax_to_fpt": true,
"fixed_product_taxes_display_prices_in_emails": 987,
- "fixed_product_taxes_display_prices_in_product_lists": 123,
+ "fixed_product_taxes_display_prices_in_product_lists": 987,
"fixed_product_taxes_display_prices_in_sales_modules": 123,
- "fixed_product_taxes_display_prices_on_product_view_page": 987,
- "fixed_product_taxes_enable": true,
+ "fixed_product_taxes_display_prices_on_product_view_page": 123,
+ "fixed_product_taxes_enable": false,
"fixed_product_taxes_include_fpt_in_subtotal": false,
"front": "xyz789",
- "graphql_share_all_customer_groups": true,
"graphql_share_customer_group": false,
"grid_per_page": 987,
- "grid_per_page_values": "abc123",
+ "grid_per_page_values": "xyz789",
"grouped_product_image": "ITSELF",
"head_includes": "xyz789",
"head_shortcut_icon": "abc123",
- "header_logo_src": "abc123",
- "id": 123,
- "is_checkout_agreements_enabled": true,
+ "header_logo_src": "xyz789",
+ "id": 987,
+ "is_checkout_agreements_enabled": false,
"is_default_store": true,
"is_default_store_group": true,
"is_guest_checkout_enabled": true,
"is_negotiable_quote_active": true,
- "is_one_page_checkout_enabled": true,
- "is_requisition_list_active": "xyz789",
+ "is_one_page_checkout_enabled": false,
+ "is_requisition_list_active": "abc123",
"list_mode": "xyz789",
"list_per_page": 987,
"list_per_page_values": "xyz789",
"locale": "xyz789",
- "logo_alt": "abc123",
+ "logo_alt": "xyz789",
"logo_height": 987,
- "logo_width": 987,
+ "logo_width": 123,
"magento_reward_general_is_enabled": "xyz789",
- "magento_reward_general_is_enabled_on_front": "abc123",
- "magento_reward_general_min_points_balance": "xyz789",
+ "magento_reward_general_is_enabled_on_front": "xyz789",
+ "magento_reward_general_min_points_balance": "abc123",
"magento_reward_general_publish_history": "abc123",
- "magento_reward_points_invitation_customer": "abc123",
- "magento_reward_points_invitation_customer_limit": "abc123",
- "magento_reward_points_invitation_order": "xyz789",
- "magento_reward_points_invitation_order_limit": "abc123",
+ "magento_reward_points_invitation_customer": "xyz789",
+ "magento_reward_points_invitation_customer_limit": "xyz789",
+ "magento_reward_points_invitation_order": "abc123",
+ "magento_reward_points_invitation_order_limit": "xyz789",
"magento_reward_points_newsletter": "abc123",
"magento_reward_points_order": "xyz789",
- "magento_reward_points_register": "abc123",
- "magento_reward_points_review": "xyz789",
- "magento_reward_points_review_limit": "abc123",
+ "magento_reward_points_register": "xyz789",
+ "magento_reward_points_review": "abc123",
+ "magento_reward_points_review_limit": "xyz789",
"magento_wishlist_general_is_enabled": "abc123",
- "max_items_in_order_summary": 123,
- "maximum_number_of_wishlists": "abc123",
+ "max_items_in_order_summary": 987,
+ "maximum_number_of_wishlists": "xyz789",
"minicart_display": true,
"minicart_max_items": 987,
- "minimum_password_length": "xyz789",
- "newsletter_enabled": false,
+ "minimum_password_length": "abc123",
+ "newsletter_enabled": true,
"no_route": "abc123",
- "optional_zip_countries": "xyz789",
- "order_cancellation_enabled": true,
+ "optional_zip_countries": "abc123",
+ "order_cancellation_enabled": false,
"order_cancellation_reasons": [CancellationReason],
- "orders_invoices_credit_memos_display_full_summary": false,
- "orders_invoices_credit_memos_display_grandtotal": false,
+ "orders_invoices_credit_memos_display_full_summary": true,
+ "orders_invoices_credit_memos_display_grandtotal": true,
"orders_invoices_credit_memos_display_price": 987,
"orders_invoices_credit_memos_display_shipping_amount": 123,
"orders_invoices_credit_memos_display_subtotal": 123,
- "orders_invoices_credit_memos_display_zero_tax": false,
- "payment_payflowpro_cc_vault_active": "abc123",
- "printed_card_price": "xyz789",
+ "orders_invoices_credit_memos_display_zero_tax": true,
+ "payment_payflowpro_cc_vault_active": "xyz789",
+ "printed_card_price": "abc123",
"printed_card_priceV2": Money,
"product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
"product_reviews_enabled": "abc123",
- "product_url_suffix": "abc123",
+ "product_url_suffix": "xyz789",
"quickorder_active": true,
"required_character_classes_number": "abc123",
- "returns_enabled": "abc123",
+ "returns_enabled": "xyz789",
"root_category_id": 987,
- "root_category_uid": 4,
+ "root_category_uid": "4",
"sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
- "sales_gift_wrapping": "xyz789",
- "sales_printed_card": "xyz789",
+ "sales_gift_wrapping": "abc123",
+ "sales_printed_card": "abc123",
"secure_base_link_url": "abc123",
- "secure_base_media_url": "abc123",
+ "secure_base_media_url": "xyz789",
"secure_base_static_url": "abc123",
"secure_base_url": "abc123",
"send_friend": SendFriendConfiguration,
- "share_all_catalog_rules": false,
- "share_all_sales_rule": false,
- "share_applied_catalog_rules": true,
- "share_applied_sales_rule": false,
- "shopping_cart_display_full_summary": true,
+ "share_active_segments": true,
+ "share_applied_cart_rule": false,
+ "shopping_cart_display_full_summary": false,
"shopping_cart_display_grand_total": true,
"shopping_cart_display_price": 987,
- "shopping_cart_display_shipping": 123,
+ "shopping_cart_display_shipping": 987,
"shopping_cart_display_subtotal": 987,
"shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX",
"shopping_cart_display_zero_tax": true,
"show_cms_breadcrumbs": 987,
- "store_code": "4",
- "store_group_code": 4,
+ "store_code": 4,
+ "store_group_code": "4",
"store_group_name": "abc123",
"store_name": "xyz789",
- "store_sort_order": 987,
- "timezone": "xyz789",
+ "store_sort_order": 123,
+ "timezone": "abc123",
"title_prefix": "abc123",
- "title_separator": "abc123",
+ "title_separator": "xyz789",
"title_suffix": "abc123",
- "use_store_in_url": true,
+ "use_store_in_url": false,
"website_code": "4",
"website_id": 987,
- "website_name": "xyz789",
+ "website_name": "abc123",
"weight_unit": "abc123",
- "welcome": "abc123",
+ "welcome": "xyz789",
"zero_subtotal_enable_for_specific_countries": false,
- "zero_subtotal_enabled": true,
+ "zero_subtotal_enabled": false,
"zero_subtotal_new_order_status": "xyz789",
- "zero_subtotal_payment_action": "abc123",
- "zero_subtotal_payment_from_specific_countries": "abc123",
- "zero_subtotal_sort_order": 123,
- "zero_subtotal_title": "abc123"
+ "zero_subtotal_payment_action": "xyz789",
+ "zero_subtotal_payment_from_specific_countries": "xyz789",
+ "zero_subtotal_sort_order": 987,
+ "zero_subtotal_title": "xyz789"
}
}
}
@@ -7153,10 +7279,10 @@ Response
{
"data": {
"urlResolver": {
- "canonical_url": "xyz789",
- "entity_uid": "4",
+ "canonical_url": "abc123",
+ "entity_uid": 4,
"id": 123,
- "redirectCode": 987,
+ "redirectCode": 123,
"relative_url": "xyz789",
"type": "CMS_PAGE"
}
@@ -7221,8 +7347,8 @@ Response
"data": {
"wishlist": {
"items": [WishlistItem],
- "items_count": 987,
- "name": "abc123",
+ "items_count": 123,
+ "name": "xyz789",
"sharing_code": "xyz789",
"updated_at": "abc123"
}
@@ -7293,7 +7419,7 @@ Variables
Response
-{"data": {"acceptCompanyInvitation": {"success": false}}}
+ {"data": {"acceptCompanyInvitation": {"success": true}}}
Response
"comments": [NegotiableQuoteComment], "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], - "is_min_max_qty_used": true, + "is_min_max_qty_used": false, "is_virtual": true, "items": [CartItemInterface], "max_order_commitment": 123, - "min_order_commitment": 987, + "min_order_commitment": 123, "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, @@ -7414,7 +7540,7 @@Response
NegotiableQuoteShippingAddress ], "status": "abc123", - "template_id": 4, + "template_id": "4", "total_quantity": 123.45 } } @@ -7897,7 +8023,86 @@Response
"attributes": [ComparableAttribute], "item_count": 987, "items": [ComparableItem], - "uid": 4 + "uid": "4" + } + } +} + + + + back to top + + +
+ addProductsToNewCart
+
+ Description
+Creates a new cart and add any type of product to it
+Response
+ Returns an AddProductsToNewCartOutput
+
Arguments
+| Name | +Description | +
|---|---|
+ cartItems - [CartItemInput!]!
+ |
+ An array that defines the products to add to the new cart | +
Example
+Query
+mutation addProductsToNewCart($cartItems: [CartItemInput!]!) {
+ addProductsToNewCart(cartItems: $cartItems) {
+ cart {
+ ...CartFragment
+ }
+ user_errors {
+ ...CartUserInputErrorFragment
+ }
+ }
+}
+
+ Variables
+{"cartItems": [CartItemInput]}
+
+ Response
+{
+ "data": {
+ "addProductsToNewCart": {
+ "cart": Cart,
+ "user_errors": [CartUserInputError]
}
}
}
@@ -7977,7 +8182,7 @@ Query
Variables
{
- "requisitionListUid": 4,
+ "requisitionListUid": "4",
"requisitionListItems": [RequisitionListItemsInput]
}
@@ -8698,7 +8903,10 @@ Query
Variables
- {"wishlistId": "4", "wishlistItemIds": [4]}
+ {
+ "wishlistId": "4",
+ "wishlistItemIds": ["4"]
+}
@@ -9213,7 +9421,7 @@ Response
"data": {
"assignCompareListToCustomer": {
"compare_list": CompareList,
- "result": true
+ "result": false
}
}
}
@@ -9317,7 +9525,7 @@ Query
}
printed_card_included
rules {
- ...CartRuleFragment
+ ...CartRuleStorefrontFragment
}
selected_payment_method {
...SelectedPaymentMethodFragment
@@ -9350,20 +9558,20 @@ Response
AvailablePaymentMethod
],
"billing_address": BillingCartAddress,
- "email": "abc123",
+ "email": "xyz789",
"gift_message": GiftMessage,
- "gift_receipt_included": false,
+ "gift_receipt_included": true,
"gift_wrapping": GiftWrapping,
"id": "4",
- "is_virtual": false,
+ "is_virtual": true,
"items": [CartItemInterface],
"itemsV2": CartItems,
"prices": CartPrices,
"printed_card_included": false,
- "rules": [CartRule],
+ "rules": [CartRuleStorefront],
"selected_payment_method": SelectedPaymentMethod,
"shipping_addresses": [ShippingCartAddress],
- "total_quantity": 987.65
+ "total_quantity": 123.45
}
}
}
@@ -9472,12 +9680,12 @@ Response
"comments": [NegotiableQuoteComment],
"expiration_date": "xyz789",
"history": [NegotiableQuoteHistoryEntry],
- "is_min_max_qty_used": false,
+ "is_min_max_qty_used": true,
"is_virtual": true,
"items": [CartItemInterface],
- "max_order_commitment": 123,
+ "max_order_commitment": 987,
"min_order_commitment": 123,
- "name": "abc123",
+ "name": "xyz789",
"notifications": [QuoteTemplateNotificationMessage],
"prices": CartPrices,
"reference_document_links": [
@@ -9488,7 +9696,7 @@ Response
],
"status": "xyz789",
"template_id": 4,
- "total_quantity": 987.65
+ "total_quantity": 123.45
}
}
}
@@ -9568,7 +9776,7 @@ Response
{
"data": {
"cancelOrder": {
- "error": "xyz789",
+ "error": "abc123",
"errorV2": CancelOrderError,
"order": CustomerOrder
}
@@ -9752,7 +9960,7 @@ Query
...GiftRegistryFragment
}
group {
- ...CustomerGroupFragment
+ ...CustomerGroupStorefrontFragment
}
group_id
id
@@ -9799,7 +10007,7 @@ Query
...CompanyRoleFragment
}
segments {
- ...CustomerSegmentFragment
+ ...CustomerSegmentStorefrontFragment
}
status
store_credit {
@@ -9828,7 +10036,7 @@ Query
Variables
{
- "currentPassword": "abc123",
+ "currentPassword": "xyz789",
"newPassword": "xyz789"
}
@@ -9840,50 +10048,50 @@ Response
"changeCustomerPassword": {
"addresses": [CustomerAddress],
"addressesV2": CustomerAddresses,
- "allow_remote_shopping_assistance": false,
+ "allow_remote_shopping_assistance": true,
"companies": UserCompaniesOutput,
"compare_list": CompareList,
"confirmation_status": "ACCOUNT_CONFIRMED",
"created_at": "xyz789",
"custom_attributes": [AttributeValueInterface],
- "date_of_birth": "abc123",
+ "date_of_birth": "xyz789",
"default_billing": "abc123",
"default_shipping": "abc123",
- "dob": "xyz789",
+ "dob": "abc123",
"email": "abc123",
"firstname": "abc123",
- "gender": 123,
+ "gender": 987,
"gift_registries": [GiftRegistry],
"gift_registry": GiftRegistry,
- "group": CustomerGroup,
+ "group": CustomerGroupStorefront,
"group_id": 123,
- "id": 987,
- "is_subscribed": true,
+ "id": "4",
+ "is_subscribed": false,
"job_title": "xyz789",
- "lastname": "xyz789",
+ "lastname": "abc123",
"middlename": "abc123",
"orders": CustomerOrders,
- "prefix": "abc123",
+ "prefix": "xyz789",
"purchase_order": PurchaseOrder,
"purchase_order_approval_rule": PurchaseOrderApprovalRule,
"purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata,
"purchase_order_approval_rules": PurchaseOrderApprovalRules,
"purchase_orders": PurchaseOrders,
- "purchase_orders_enabled": true,
+ "purchase_orders_enabled": false,
"requisition_lists": RequisitionLists,
"return": Return,
"returns": Returns,
"reviews": ProductReviews,
"reward_points": RewardPoints,
"role": CompanyRole,
- "segments": [CustomerSegment],
+ "segments": [CustomerSegmentStorefront],
"status": "ACTIVE",
"store_credit": CustomerStoreCredit,
- "structure_id": "4",
+ "structure_id": 4,
"suffix": "xyz789",
"taxvat": "abc123",
"team": CompanyTeam,
- "telephone": "xyz789",
+ "telephone": "abc123",
"wishlist": Wishlist,
"wishlist_v2": Wishlist,
"wishlists": [Wishlist]
@@ -10043,6 +10251,85 @@ Response
"clearCustomerCart": {"cart": Cart, "status": false}
}
}
+
+
+
+ back to top
+
+ clearWishlist
+
+ Description
+Remove all the products from the specified wish list.
+Response
+ Returns a RemoveProductsFromWishlistOutput
+
Arguments
+| Name | +Description | +
|---|---|
+ wishlistId - ID!
+ |
+ The ID of a wish list. | +
Example
+Query
+mutation clearWishlist($wishlistId: ID!) {
+ clearWishlist(wishlistId: $wishlistId) {
+ user_errors {
+ ...WishListUserInputErrorFragment
+ }
+ wishlist {
+ ...WishlistFragment
+ }
+ }
+}
+
+ Variables
+{"wishlistId": "4"}
+
+ Response
+{
+ "data": {
+ "clearWishlist": {
+ "user_errors": [WishListUserInputError],
+ "wishlist": Wishlist
+ }
+ }
+}
Response
} } } + +
+ completeOrder
+
+ Description
+Synchronizes order details and place the order
+Response
+ Returns a PlaceOrderOutput
+
Arguments
+| Name | +Description | +
|---|---|
+ input - CompleteOrderInput
+ |
+ Describes the variables needed to complete or place the order | +
Example
+Query
+mutation completeOrder($input: CompleteOrderInput) {
+ completeOrder(input: $input) {
+ errors {
+ ...PlaceOrderErrorFragment
+ }
+ order {
+ ...OrderFragment
+ }
+ orderV2 {
+ ...CustomerOrderFragment
+ }
+ }
+}
+
+ Variables
+{"input": CompleteOrderInput}
+
+ Response
+{
+ "data": {
+ "completeOrder": {
+ "errors": [PlaceOrderError],
+ "order": Order,
+ "orderV2": CustomerOrder
+ }
+ }
+}
Response
{
"data": {
"confirmCancelOrder": {
- "error": "xyz789",
+ "error": "abc123",
"errorV2": CancelOrderError,
"order": CustomerOrder
}
@@ -10518,7 +10888,7 @@ Query
Variables
{
"sourceRequisitionListUid": 4,
- "destinationRequisitionListUid": "4",
+ "destinationRequisitionListUid": 4,
"requisitionListItem": CopyItemsBetweenRequisitionListsInput
}
@@ -10622,8 +10992,8 @@ Query
Variables
{
- "sourceWishlistUid": 4,
- "destinationWishlistUid": "4",
+ "sourceWishlistUid": "4",
+ "destinationWishlistUid": 4,
"wishlistItems": [WishlistItemCopyInput]
}
@@ -10726,7 +11096,7 @@ Query
Response
{
"data": {
- "createBraintreePayPalClientToken": "abc123"
+ "createBraintreePayPalClientToken": "xyz789"
}
}
@@ -11157,9 +11527,9 @@ Response
"data": {
"createCompareList": {
"attributes": [ComparableAttribute],
- "item_count": 987,
+ "item_count": 123,
"items": [ComparableItem],
- "uid": 4
+ "uid": "4"
}
}
}
@@ -11316,6 +11686,7 @@ Query
street
suffix
telephone
+ uid
vat_id
}
}
@@ -11332,28 +11703,29 @@ Response
"data": {
"createCustomerAddress": {
"city": "xyz789",
- "company": "abc123",
+ "company": "xyz789",
"country_code": "AF",
- "country_id": "abc123",
+ "country_id": "xyz789",
"custom_attributes": [CustomerAddressAttribute],
"custom_attributesV2": [AttributeValueInterface],
"customer_id": 987,
- "default_billing": false,
+ "default_billing": true,
"default_shipping": false,
"extension_attributes": [CustomerAddressAttribute],
- "fax": "xyz789",
+ "fax": "abc123",
"firstname": "xyz789",
- "id": 123,
- "lastname": "xyz789",
- "middlename": "xyz789",
+ "id": 987,
+ "lastname": "abc123",
+ "middlename": "abc123",
"postcode": "abc123",
- "prefix": "abc123",
+ "prefix": "xyz789",
"region": CustomerAddressRegion,
- "region_id": 123,
+ "region_id": 987,
"street": ["xyz789"],
- "suffix": "xyz789",
- "telephone": "abc123",
- "vat_id": "xyz789"
+ "suffix": "abc123",
+ "telephone": "xyz789",
+ "uid": "4",
+ "vat_id": "abc123"
}
}
}
@@ -11497,7 +11869,7 @@ Variables
Response
- {"data": {"createEmptyCart": "xyz789"}}
+ {"data": {"createEmptyCart": "abc123"}}
Response
{
"data": {
"createPayflowProToken": {
- "response_message": "xyz789",
- "result": 987,
- "result_code": 123,
- "secure_token": "xyz789",
- "secure_token_id": "abc123"
+ "response_message": "abc123",
+ "result": 123,
+ "result_code": 987,
+ "secure_token": "abc123",
+ "secure_token_id": "xyz789"
}
}
}
@@ -11795,9 +12167,9 @@ Response
{
"data": {
"createPaymentOrder": {
- "amount": 987.65,
+ "amount": 123.45,
"currency_code": "xyz789",
- "id": "abc123",
+ "id": "xyz789",
"mp_order_id": "abc123",
"status": "xyz789"
}
@@ -12041,13 +12413,13 @@ Response
"applies_to_roles": [CompanyRole],
"approver_roles": [CompanyRole],
"condition": PurchaseOrderApprovalRuleConditionInterface,
- "created_at": "xyz789",
+ "created_at": "abc123",
"created_by": "xyz789",
"description": "xyz789",
- "name": "xyz789",
+ "name": "abc123",
"status": "ENABLED",
"uid": "4",
- "updated_at": "xyz789"
+ "updated_at": "abc123"
}
}
}
@@ -12273,7 +12645,7 @@ Response
{
"data": {
"createVaultCardSetupToken": {
- "setup_token": "abc123"
+ "setup_token": "xyz789"
}
}
}
@@ -12413,7 +12785,7 @@ Variables
Response
- {"data": {"deleteCompanyRole": {"success": true}}}
+ {"data": {"deleteCompanyRole": {"success": false}}}
@@ -12481,7 +12853,7 @@ Variables
Response
- {"data": {"deleteCompanyTeam": {"success": true}}}
+ {"data": {"deleteCompanyTeam": {"success": false}}}
@@ -12556,7 +12928,7 @@ Variables
Response
- {"data": {"deleteCompanyUser": {"success": false}}}
+ {"data": {"deleteCompanyUser": {"success": true}}}
@@ -12624,7 +12996,7 @@ Variables
Response
- {"data": {"deleteCompanyUserV2": {"success": true}}}
+ {"data": {"deleteCompanyUserV2": {"success": false}}}
@@ -12691,7 +13063,7 @@ Variables
Response
- {"data": {"deleteCompareList": {"result": false}}}
+ {"data": {"deleteCompareList": {"result": true}}}
@@ -12743,9 +13115,16 @@ Response
-
+
deleteCustomerAddress
+
+
+
+ Use deleteCustomerAddressV2 instead.
+
+
+
@@ -12792,12 +13171,77 @@ Query
Variables
- {"id": 123}
+ {"id": 987}
+
+
+
+ Response
+ {"data": {"deleteCustomerAddress": true}}
+
+
+
+ back to top
+
+
+ deleteCustomerAddressV2
+
+ Description
+Delete the billing or shipping address of a customer.
+Response
+ Returns a Boolean
+
Arguments
+| Name | +Description | +
|---|---|
+ uid - ID!
+ |
+ The unique ID of the customer address to be deleted. | +
Example
+Query
+mutation deleteCustomerAddressV2($uid: ID!) {
+ deleteCustomerAddressV2(uid: $uid)
+}
+
+ Variables
+{"uid": 4}
Response
-{"data": {"deleteCustomerAddress": false}}
+ {"data": {"deleteCustomerAddressV2": true}}
Variables
Response
-{"data": {"deleteNegotiableQuoteTemplate": true}}
+ {"data": {"deleteNegotiableQuoteTemplate": false}}
Query
Variables
-{"public_hash": "abc123"}
+ {"public_hash": "xyz789"}
Response
"data": { "deleteRequisitionList": { "requisition_lists": RequisitionLists, - "status": true + "status": false } } } @@ -13256,10 +13700,7 @@Query
Variables
-{
- "requisitionListUid": 4,
- "requisitionListItemUids": ["4"]
-}
+ {"requisitionListUid": 4, "requisitionListItemUids": [4]}
Query
Variables
-{"wishlistId": 4}
+ {"wishlistId": "4"}
Response
"estimateShippingMethods": [ { "amount": Money, - "available": false, + "available": true, "base_amount": Money, "carrier_code": "xyz789", - "carrier_title": "abc123", - "error_message": "xyz789", - "method_code": "abc123", - "method_title": "xyz789", + "carrier_title": "xyz789", + "error_message": "abc123", + "method_code": "xyz789", + "method_title": "abc123", "price_excl_tax": Money, "price_incl_tax": Money } @@ -13591,6 +14032,83 @@Variables
Response
{"data": {"estimateTotals": {"cart": Cart}}}
+
+
+ exchangeExternalCustomerToken
+
+ Description
+Generate a token for specified customer.
+Response
+ Returns an ExchangeExternalCustomerTokenOutput
+
Arguments
+| Name | +Description | +
|---|---|
+ input - ExchangeExternalCustomerTokenInput
+ |
+ Contains details about external customer. | +
Example
+Query
+mutation exchangeExternalCustomerToken($input: ExchangeExternalCustomerTokenInput) {
+ exchangeExternalCustomerToken(input: $input) {
+ customer {
+ ...CustomerFragment
+ }
+ token
+ }
+}
+
+ Variables
+{"input": ExchangeExternalCustomerTokenInput}
+
+ Response
+{
+ "data": {
+ "exchangeExternalCustomerToken": {
+ "customer": Customer,
+ "token": "abc123"
+ }
+ }
+}
Query
Variables
{
"email": "xyz789",
- "password": "abc123"
+ "password": "xyz789"
}
Response
{
"data": {
"generateCustomerToken": {
- "token": "abc123"
+ "token": "xyz789"
}
}
}
@@ -13748,7 +14266,7 @@ Response
{
"data": {
"generateCustomerTokenAsAdmin": {
- "customer_token": "xyz789"
+ "customer_token": "abc123"
}
}
}
@@ -13818,7 +14336,13 @@ Variables
Response
- {"data": {"generateNegotiableQuoteFromTemplate": {"negotiable_quote_uid": 4}}}
+ {
+ "data": {
+ "generateNegotiableQuoteFromTemplate": {
+ "negotiable_quote_uid": "4"
+ }
+ }
+}
@@ -13999,7 +14523,7 @@ Query
}
printed_card_included
rules {
- ...CartRuleFragment
+ ...CartRuleStorefrontFragment
}
selected_payment_method {
...SelectedPaymentMethodFragment
@@ -14039,13 +14563,13 @@ Response
"gift_message": GiftMessage,
"gift_receipt_included": false,
"gift_wrapping": GiftWrapping,
- "id": "4",
+ "id": 4,
"is_virtual": false,
"items": [CartItemInterface],
"itemsV2": CartItems,
"prices": CartPrices,
- "printed_card_included": false,
- "rules": [CartRule],
+ "printed_card_included": true,
+ "rules": [CartRuleStorefront],
"selected_payment_method": SelectedPaymentMethod,
"shipping_addresses": [ShippingCartAddress],
"total_quantity": 123.45
@@ -14131,7 +14655,7 @@ Query
Variables
- {"cartUid": "4", "giftRegistryUid": 4}
+ {"cartUid": 4, "giftRegistryUid": "4"}
@@ -14140,7 +14664,7 @@ Response
"data": {
"moveCartItemsToGiftRegistry": {
"gift_registry": GiftRegistry,
- "status": true,
+ "status": false,
"user_errors": [GiftRegistryItemsUserError]
}
}
@@ -14233,7 +14757,7 @@ Query
Variables
{
"sourceRequisitionListUid": 4,
- "destinationRequisitionListUid": "4",
+ "destinationRequisitionListUid": 4,
"requisitionListItem": MoveItemsBetweenRequisitionListsInput
}
@@ -14413,7 +14937,7 @@ Query
Variables
{
- "sourceWishlistUid": 4,
+ "sourceWishlistUid": "4",
"destinationWishlistUid": "4",
"wishlistItems": [WishlistItemMoveInput]
}
@@ -14535,12 +15059,12 @@ Response
"comments": [NegotiableQuoteComment],
"expiration_date": "abc123",
"history": [NegotiableQuoteHistoryEntry],
- "is_min_max_qty_used": true,
- "is_virtual": true,
+ "is_min_max_qty_used": false,
+ "is_virtual": false,
"items": [CartItemInterface],
"max_order_commitment": 123,
"min_order_commitment": 987,
- "name": "xyz789",
+ "name": "abc123",
"notifications": [QuoteTemplateNotificationMessage],
"prices": CartPrices,
"reference_document_links": [
@@ -14549,9 +15073,9 @@ Response
"shipping_addresses": [
NegotiableQuoteShippingAddress
],
- "status": "xyz789",
- "template_id": 4,
- "total_quantity": 123.45
+ "status": "abc123",
+ "template_id": "4",
+ "total_quantity": 987.65
}
}
}
@@ -14931,7 +15455,7 @@ Response
"data": {
"redeemGiftCardBalanceAsStoreCredit": {
"balance": Money,
- "code": "xyz789",
+ "code": "abc123",
"expiration_date": "abc123"
}
}
@@ -15289,7 +15813,7 @@ Variables
Response
- {"data": {"removeGiftRegistry": {"success": true}}}
+ {"data": {"removeGiftRegistry": {"success": false}}}
@@ -15452,7 +15976,10 @@ Query
Variables
- {"giftRegistryUid": 4, "registrantsUid": [4]}
+ {
+ "giftRegistryUid": "4",
+ "registrantsUid": ["4"]
+}
@@ -15711,14 +16238,14 @@ Response
"removeNegotiableQuoteTemplateItems": {
"buyer": NegotiableQuoteUser,
"comments": [NegotiableQuoteComment],
- "expiration_date": "abc123",
+ "expiration_date": "xyz789",
"history": [NegotiableQuoteHistoryEntry],
"is_min_max_qty_used": false,
- "is_virtual": true,
+ "is_virtual": false,
"items": [CartItemInterface],
- "max_order_commitment": 987,
+ "max_order_commitment": 123,
"min_order_commitment": 987,
- "name": "abc123",
+ "name": "xyz789",
"notifications": [QuoteTemplateNotificationMessage],
"prices": CartPrices,
"reference_document_links": [
@@ -15727,7 +16254,7 @@ Response
"shipping_addresses": [
NegotiableQuoteShippingAddress
],
- "status": "xyz789",
+ "status": "abc123",
"template_id": 4,
"total_quantity": 987.65
}
@@ -15894,7 +16421,7 @@ Query
Variables
- {"wishlistId": 4, "wishlistItemsIds": ["4"]}
+ {"wishlistId": "4", "wishlistItemsIds": [4]}
@@ -16597,14 +17124,14 @@ Response
"requestNegotiableQuoteTemplateFromQuote": {
"buyer": NegotiableQuoteUser,
"comments": [NegotiableQuoteComment],
- "expiration_date": "abc123",
+ "expiration_date": "xyz789",
"history": [NegotiableQuoteHistoryEntry],
- "is_min_max_qty_used": false,
- "is_virtual": true,
+ "is_min_max_qty_used": true,
+ "is_virtual": false,
"items": [CartItemInterface],
- "max_order_commitment": 987,
+ "max_order_commitment": 123,
"min_order_commitment": 987,
- "name": "xyz789",
+ "name": "abc123",
"notifications": [QuoteTemplateNotificationMessage],
"prices": CartPrices,
"reference_document_links": [
@@ -16614,8 +17141,8 @@ Response
NegotiableQuoteShippingAddress
],
"status": "xyz789",
- "template_id": 4,
- "total_quantity": 123.45
+ "template_id": "4",
+ "total_quantity": 987.65
}
}
}
@@ -16683,7 +17210,7 @@ Variables
Response
- {"data": {"requestPasswordResetEmail": false}}
+ {"data": {"requestPasswordResetEmail": true}}
@@ -16827,7 +17354,7 @@ Variables
Response
- {"data": {"resendConfirmationEmail": true}}
+ {"data": {"resendConfirmationEmail": false}}
@@ -16908,7 +17435,7 @@ Query
Variables
{
- "email": "abc123",
+ "email": "xyz789",
"resetPasswordToken": "xyz789",
"newPassword": "xyz789"
}
@@ -16959,7 +17486,7 @@ Query
Response
- {"data": {"revokeCustomerToken": {"result": true}}}
+ {"data": {"revokeCustomerToken": {"result": false}}}
@@ -17183,6 +17710,81 @@ Variables
Response
{"data": {"setBillingAddressOnCart": {"cart": Cart}}}
+
+
+
+ back to top
+
+
+ setCartAsInactive
+
+ Description
+Sets the cart as inactive
+Response
+ Returns a SetCartAsInactiveOutput
+
Arguments
+| Name | +Description | +
|---|---|
+ cartId - String!
+ |
+ The customer cart ID | +
Example
+Query
+mutation setCartAsInactive($cartId: String!) {
+ setCartAsInactive(cartId: $cartId) {
+ error
+ success
+ }
+}
+
+ Variables
+{"cartId": "xyz789"}
+
+ Response
+{
+ "data": {
+ "setCartAsInactive": {
+ "error": "xyz789",
+ "success": true
+ }
+ }
+}
Response
"setNegotiableQuoteTemplateShippingAddress": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "expiration_date": "abc123", + "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], "is_min_max_qty_used": true, - "is_virtual": false, + "is_virtual": true, "items": [CartItemInterface], - "max_order_commitment": 987, + "max_order_commitment": 123, "min_order_commitment": 123, "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], @@ -17810,8 +18412,8 @@Response
NegotiableQuoteShippingAddress ], "status": "abc123", - "template_id": "4", - "total_quantity": 123.45 + "template_id": 4, + "total_quantity": 987.65 } } } @@ -18080,12 +18682,12 @@Response
"comments": [NegotiableQuoteComment], "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], - "is_min_max_qty_used": true, - "is_virtual": true, + "is_min_max_qty_used": false, + "is_virtual": false, "items": [CartItemInterface], - "max_order_commitment": 987, + "max_order_commitment": 123, "min_order_commitment": 987, - "name": "xyz789", + "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ @@ -18095,7 +18697,7 @@Response
NegotiableQuoteShippingAddress ], "status": "abc123", - "template_id": 4, + "template_id": "4", "total_quantity": 987.65 } } @@ -18328,7 +18930,7 @@Variables
Response
-{"data": {"shareGiftRegistry": {"is_shared": false}}}
+ {"data": {"shareGiftRegistry": {"is_shared": true}}}
Response
"is_min_max_qty_used": false, "is_virtual": true, "items": [CartItemInterface], - "max_order_commitment": 987, + "max_order_commitment": 123, "min_order_commitment": 987, "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], @@ -18448,8 +19050,8 @@Response
"shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "xyz789", - "template_id": "4", + "status": "abc123", + "template_id": 4, "total_quantity": 987.65 } } @@ -18586,71 +19188,6 @@Variables
Response
{"data": {"syncPaymentOrder": false}}
-
-
- trackViewedProduct
-
- Description
-Track that a product was viewed in adobe commerce
-Response
- Returns a Boolean
-
Arguments
-| Name | -Description | -
|---|---|
- sku - String!
- |
- The sku for a ProductInterface object. |
-
Example
-Query
-mutation trackViewedProduct($sku: String!) {
- trackViewedProduct(sku: $sku)
-}
-
- Variables
-{"sku": "xyz789"}
-
- Response
-{"data": {"trackViewedProduct": true}}
Response
-
+
updateCustomerAddress
+
+
+
+ Use updateCustomerAddressV2 instead.
+
+
+
@@ -19244,6 +19788,7 @@ Query
street
suffix
telephone
+ uid
vat_id
}
}
@@ -19259,28 +19804,168 @@ Response
{
"data": {
"updateCustomerAddress": {
- "city": "xyz789",
- "company": "abc123",
+ "city": "abc123",
+ "company": "xyz789",
"country_code": "AF",
"country_id": "xyz789",
"custom_attributes": [CustomerAddressAttribute],
"custom_attributesV2": [AttributeValueInterface],
- "customer_id": 123,
- "default_billing": true,
+ "customer_id": 987,
+ "default_billing": false,
"default_shipping": true,
"extension_attributes": [CustomerAddressAttribute],
- "fax": "xyz789",
+ "fax": "abc123",
"firstname": "xyz789",
- "id": 987,
- "lastname": "abc123",
- "middlename": "xyz789",
+ "id": 123,
+ "lastname": "xyz789",
+ "middlename": "abc123",
"postcode": "xyz789",
"prefix": "abc123",
"region": CustomerAddressRegion,
"region_id": 123,
- "street": ["xyz789"],
+ "street": ["abc123"],
"suffix": "xyz789",
- "telephone": "abc123",
+ "telephone": "xyz789",
+ "uid": 4,
+ "vat_id": "xyz789"
+ }
+ }
+}
+
+
+
+ back to top
+
+
+
+
+ Mutations
+
+
+ updateCustomerAddressV2
+
+
+
+
+ Description
+ Update the billing or shipping address of a customer or guest.
+
+
+
+
+
+
+ Response
+ Returns a CustomerAddress
+
+
+
+ Arguments
+
+
+
+ Name
+ Description
+
+
+
+
+
+ uid - ID!
+
+ The unique ID of the customer address.
+
+
+
+ input - CustomerAddressInput
+
+ An input object that contains changes to the customer address.
+
+
+
+
+
+
+ Example
+
+ Query
+ mutation updateCustomerAddressV2(
+ $uid: ID!,
+ $input: CustomerAddressInput
+) {
+ updateCustomerAddressV2(
+ uid: $uid,
+ input: $input
+ ) {
+ city
+ company
+ country_code
+ country_id
+ custom_attributes {
+ ...CustomerAddressAttributeFragment
+ }
+ custom_attributesV2 {
+ ...AttributeValueInterfaceFragment
+ }
+ customer_id
+ default_billing
+ default_shipping
+ extension_attributes {
+ ...CustomerAddressAttributeFragment
+ }
+ fax
+ firstname
+ id
+ lastname
+ middlename
+ postcode
+ prefix
+ region {
+ ...CustomerAddressRegionFragment
+ }
+ region_id
+ street
+ suffix
+ telephone
+ uid
+ vat_id
+ }
+}
+
+
+
+ Variables
+ {"uid": 4, "input": CustomerAddressInput}
+
+
+
+ Response
+ {
+ "data": {
+ "updateCustomerAddressV2": {
+ "city": "abc123",
+ "company": "abc123",
+ "country_code": "AF",
+ "country_id": "abc123",
+ "custom_attributes": [CustomerAddressAttribute],
+ "custom_attributesV2": [AttributeValueInterface],
+ "customer_id": 987,
+ "default_billing": false,
+ "default_shipping": true,
+ "extension_attributes": [CustomerAddressAttribute],
+ "fax": "abc123",
+ "firstname": "xyz789",
+ "id": 123,
+ "lastname": "xyz789",
+ "middlename": "abc123",
+ "postcode": "xyz789",
+ "prefix": "xyz789",
+ "region": CustomerAddressRegion,
+ "region_id": 987,
+ "street": ["abc123"],
+ "suffix": "xyz789",
+ "telephone": "xyz789",
+ "uid": "4",
"vat_id": "xyz789"
}
}
@@ -19361,8 +20046,8 @@ Query
Variables
{
- "email": "xyz789",
- "password": "abc123"
+ "email": "abc123",
+ "password": "xyz789"
}
@@ -19692,7 +20377,7 @@ Query
Variables
{
- "giftRegistryUid": "4",
+ "giftRegistryUid": 4,
"registrants": [UpdateGiftRegistryRegistrantInput]
}
@@ -20038,12 +20723,12 @@ Response
"applies_to_roles": [CompanyRole],
"approver_roles": [CompanyRole],
"condition": PurchaseOrderApprovalRuleConditionInterface,
- "created_at": "abc123",
+ "created_at": "xyz789",
"created_by": "xyz789",
- "description": "abc123",
- "name": "abc123",
+ "description": "xyz789",
+ "name": "xyz789",
"status": "ENABLED",
- "uid": "4",
+ "uid": 4,
"updated_at": "xyz789"
}
}
@@ -20125,7 +20810,7 @@ Query
Variables
{
- "requisitionListUid": "4",
+ "requisitionListUid": 4,
"input": UpdateRequisitionListInput
}
@@ -20315,7 +21000,7 @@ Query
Variables
{
- "wishlistId": "4",
+ "wishlistId": 4,
"name": "xyz789",
"visibility": "PUBLIC"
}
@@ -20326,8 +21011,8 @@ Response
{
"data": {
"updateWishlist": {
- "name": "xyz789",
- "uid": 4,
+ "name": "abc123",
+ "uid": "4",
"visibility": "PUBLIC"
}
}
@@ -20450,7 +21135,7 @@ Fields
Example
- {"template_id": "4"}
+ {"template_id": 4}
@@ -20498,7 +21183,7 @@ Fields
Example
{
- "cart_id": "xyz789",
+ "cart_id": "abc123",
"cart_items": [BundleProductCartItemInput]
}
@@ -20674,7 +21359,7 @@ Fields
Example
{
- "cart_id": "xyz789",
+ "cart_id": "abc123",
"cart_items": [DownloadableProductCartItemInput]
}
@@ -20779,9 +21464,9 @@ Example
"dynamic_attributes": [
GiftRegistryDynamicAttributeInput
],
- "email": "xyz789",
- "firstname": "xyz789",
- "lastname": "xyz789"
+ "email": "abc123",
+ "firstname": "abc123",
+ "lastname": "abc123"
}
@@ -20917,7 +21602,55 @@ Fields
Example
- {"products": [4], "uid": "4"}
+ {"products": ["4"], "uid": 4}
+
+
+
+ back to top
+
+
+
+
+ Types
+
+ AddProductsToNewCartOutput
+
+
+
+ Description
+ Contains details about the cart after adding products to it.
+
+
+ Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+ cart - Cart
+
+ The cart after products have been added.
+
+
+ user_errors - [CartUserInputError]
+
+ Contains errors encountered while adding an item to the cart.
+
+
+
+
+
+
+
+ Example
+ {
+ "cart": Cart,
+ "user_errors": [CartUserInputError]
+}
@@ -21054,7 +21787,7 @@ Fields
Example
{
"comment": "abc123",
- "purchase_order_uid": "4"
+ "purchase_order_uid": 4
}
@@ -21150,7 +21883,7 @@ Fields
Example
{
"cart_id": "abc123",
- "purchase_order_uid": 4,
+ "purchase_order_uid": "4",
"replace_existing_cart_items": false
}
@@ -21198,7 +21931,7 @@ Fields
Example
{
- "message": "abc123",
+ "message": "xyz789",
"type": "OUT_OF_STOCK"
}
@@ -21363,7 +22096,7 @@ Fields
Example
{
- "comment_text": "abc123",
+ "comment_text": "xyz789",
"return_uid": "4"
}
@@ -21558,7 +22291,7 @@ Fields
Example
{
- "cart_id": "abc123",
+ "cart_id": "xyz789",
"cart_items": [SimpleProductCartItemInput]
}
@@ -21744,7 +22477,7 @@ Example
"add_wishlist_items_to_cart_user_errors": [
WishlistCartUserInputError
],
- "status": false,
+ "status": true,
"wishlist": Wishlist
}
@@ -21808,10 +22541,10 @@ Fields
Example
{
"attribute_code": "xyz789",
- "count": 123,
- "label": "xyz789",
+ "count": 987,
+ "label": "abc123",
"options": [AggregationOption],
- "position": 123
+ "position": 987
}
@@ -21865,7 +22598,7 @@ Example
{
"count": 987,
"label": "abc123",
- "value": "abc123"
+ "value": "xyz789"
}
@@ -21935,7 +22668,7 @@ Possible Types
Example
{
"count": 987,
- "label": "xyz789",
+ "label": "abc123",
"value": "abc123"
}
@@ -21978,7 +22711,7 @@ Fields
Example
- {"includeDirectChildrenOnly": false}
+ {"includeDirectChildrenOnly": true}
@@ -22094,8 +22827,8 @@ Example
"button_styles": ButtonStyles,
"code": "abc123",
"is_visible": true,
- "payment_intent": "abc123",
- "payment_source": "xyz789",
+ "payment_intent": "xyz789",
+ "payment_source": "abc123",
"sdk_params": [SDKParams],
"sort_order": "abc123",
"title": "abc123"
@@ -22154,8 +22887,8 @@ Fields
Example
{
"payment_source": "xyz789",
- "payments_order_id": "abc123",
- "paypal_order_id": "abc123"
+ "payments_order_id": "xyz789",
+ "paypal_order_id": "xyz789"
}
@@ -22196,7 +22929,7 @@ Fields
Example
- {"code": "xyz789"}
+ {"code": "abc123"}
@@ -22358,7 +23091,7 @@ Fields
Example
{
- "cart_id": "xyz789",
+ "cart_id": "abc123",
"coupon_code": "xyz789"
}
@@ -22503,7 +23236,7 @@ Fields
Example
{
- "cart_id": "xyz789",
+ "cart_id": "abc123",
"coupon_codes": ["xyz789"],
"type": "APPEND"
}
@@ -22555,7 +23288,7 @@ Fields
Example
{
"cart_id": "xyz789",
- "gift_card_code": "abc123"
+ "gift_card_code": "xyz789"
}
@@ -22725,7 +23458,7 @@ Fields
Example
- {"cart_id": "abc123"}
+ {"cart_id": "xyz789"}
@@ -22812,7 +23545,7 @@ Fields
Example
- {"radius": 987, "search_term": "xyz789"}
+ {"radius": 987, "search_term": "abc123"}
@@ -22857,7 +23590,7 @@ Fields
Example
- {"compare_list": CompareList, "result": false}
+ {"compare_list": CompareList, "result": true}
@@ -23107,18 +23840,18 @@ Fields
Example
{
- "is_comparable": false,
+ "is_comparable": true,
"is_filterable": true,
- "is_filterable_in_search": false,
- "is_html_allowed_on_front": false,
- "is_searchable": true,
- "is_used_for_customer_segment": false,
+ "is_filterable_in_search": true,
+ "is_html_allowed_on_front": true,
+ "is_searchable": false,
+ "is_used_for_customer_segment": true,
"is_used_for_price_rules": true,
- "is_used_for_promo_rules": true,
+ "is_used_for_promo_rules": false,
"is_visible_in_advanced_search": false,
"is_visible_on_front": true,
- "is_wysiwyg_enabled": true,
- "used_in_product_listing": true
+ "is_wysiwyg_enabled": false,
+ "used_in_product_listing": false
}
@@ -23314,8 +24047,8 @@ Fields
Example
{
- "attribute_code": "xyz789",
- "entity_type": "xyz789"
+ "attribute_code": "abc123",
+ "entity_type": "abc123"
}
@@ -23357,7 +24090,7 @@ Fields
Example
- {"value": "xyz789"}
+ {"value": "abc123"}
@@ -23443,8 +24176,8 @@ Example
"entity_type": "CATALOG_PRODUCT",
"frontend_class": "abc123",
"frontend_input": "BOOLEAN",
- "is_required": false,
- "is_unique": false,
+ "is_required": true,
+ "is_unique": true,
"label": "xyz789",
"options": [CustomAttributeOptionInterface]
}
@@ -23493,7 +24226,7 @@ Fields
Example
{
- "message": "xyz789",
+ "message": "abc123",
"type": "ENTITY_NOT_FOUND"
}
@@ -23600,7 +24333,7 @@ Fields
Example
{
- "label": "abc123",
+ "label": "xyz789",
"value": "xyz789"
}
@@ -23654,8 +24387,8 @@ Fields
Example
{
"is_default": true,
- "label": "abc123",
- "value": "abc123"
+ "label": "xyz789",
+ "value": "xyz789"
}
@@ -23699,7 +24432,7 @@ Fields
Example
{
"label": "xyz789",
- "value": "abc123"
+ "value": "xyz789"
}
@@ -23847,7 +24580,10 @@ Fields
Example
- {"code": 4, "value": "abc123"}
+ {
+ "code": "4",
+ "value": "xyz789"
+}
@@ -23901,7 +24637,7 @@ Fields
Example
{
- "attribute_code": "abc123",
+ "attribute_code": "xyz789",
"selected_options": [AttributeInputSelectedOption],
"value": "abc123"
}
@@ -23955,6 +24691,11 @@ Possible Types
updateCustomerAddress
updateCustomerAddressV2 instead. Query
street suffix telephone + uid vat_id } } @@ -19259,28 +19804,168 @@Response
{
"data": {
"updateCustomerAddress": {
- "city": "xyz789",
- "company": "abc123",
+ "city": "abc123",
+ "company": "xyz789",
"country_code": "AF",
"country_id": "xyz789",
"custom_attributes": [CustomerAddressAttribute],
"custom_attributesV2": [AttributeValueInterface],
- "customer_id": 123,
- "default_billing": true,
+ "customer_id": 987,
+ "default_billing": false,
"default_shipping": true,
"extension_attributes": [CustomerAddressAttribute],
- "fax": "xyz789",
+ "fax": "abc123",
"firstname": "xyz789",
- "id": 987,
- "lastname": "abc123",
- "middlename": "xyz789",
+ "id": 123,
+ "lastname": "xyz789",
+ "middlename": "abc123",
"postcode": "xyz789",
"prefix": "abc123",
"region": CustomerAddressRegion,
"region_id": 123,
- "street": ["xyz789"],
+ "street": ["abc123"],
"suffix": "xyz789",
- "telephone": "abc123",
+ "telephone": "xyz789",
+ "uid": 4,
+ "vat_id": "xyz789"
+ }
+ }
+}
+
+
+ updateCustomerAddressV2
+
+ Description
+Update the billing or shipping address of a customer or guest.
+Response
+ Returns a CustomerAddress
+
Arguments
+| Name | +Description | +
|---|---|
+ uid - ID!
+ |
+ The unique ID of the customer address. | +
+ input - CustomerAddressInput
+ |
+ An input object that contains changes to the customer address. | +
Example
+Query
+mutation updateCustomerAddressV2(
+ $uid: ID!,
+ $input: CustomerAddressInput
+) {
+ updateCustomerAddressV2(
+ uid: $uid,
+ input: $input
+ ) {
+ city
+ company
+ country_code
+ country_id
+ custom_attributes {
+ ...CustomerAddressAttributeFragment
+ }
+ custom_attributesV2 {
+ ...AttributeValueInterfaceFragment
+ }
+ customer_id
+ default_billing
+ default_shipping
+ extension_attributes {
+ ...CustomerAddressAttributeFragment
+ }
+ fax
+ firstname
+ id
+ lastname
+ middlename
+ postcode
+ prefix
+ region {
+ ...CustomerAddressRegionFragment
+ }
+ region_id
+ street
+ suffix
+ telephone
+ uid
+ vat_id
+ }
+}
+
+ Variables
+{"uid": 4, "input": CustomerAddressInput}
+
+ Response
+{
+ "data": {
+ "updateCustomerAddressV2": {
+ "city": "abc123",
+ "company": "abc123",
+ "country_code": "AF",
+ "country_id": "abc123",
+ "custom_attributes": [CustomerAddressAttribute],
+ "custom_attributesV2": [AttributeValueInterface],
+ "customer_id": 987,
+ "default_billing": false,
+ "default_shipping": true,
+ "extension_attributes": [CustomerAddressAttribute],
+ "fax": "abc123",
+ "firstname": "xyz789",
+ "id": 123,
+ "lastname": "xyz789",
+ "middlename": "abc123",
+ "postcode": "xyz789",
+ "prefix": "xyz789",
+ "region": CustomerAddressRegion,
+ "region_id": 987,
+ "street": ["abc123"],
+ "suffix": "xyz789",
+ "telephone": "xyz789",
+ "uid": "4",
"vat_id": "xyz789"
}
}
@@ -19361,8 +20046,8 @@ Query
Variables
{
- "email": "xyz789",
- "password": "abc123"
+ "email": "abc123",
+ "password": "xyz789"
}
@@ -19692,7 +20377,7 @@ Query
Variables
{
- "giftRegistryUid": "4",
+ "giftRegistryUid": 4,
"registrants": [UpdateGiftRegistryRegistrantInput]
}
@@ -20038,12 +20723,12 @@ Response
"applies_to_roles": [CompanyRole],
"approver_roles": [CompanyRole],
"condition": PurchaseOrderApprovalRuleConditionInterface,
- "created_at": "abc123",
+ "created_at": "xyz789",
"created_by": "xyz789",
- "description": "abc123",
- "name": "abc123",
+ "description": "xyz789",
+ "name": "xyz789",
"status": "ENABLED",
- "uid": "4",
+ "uid": 4,
"updated_at": "xyz789"
}
}
@@ -20125,7 +20810,7 @@ Query
Variables
{
- "requisitionListUid": "4",
+ "requisitionListUid": 4,
"input": UpdateRequisitionListInput
}
@@ -20315,7 +21000,7 @@ Query
Variables
{
- "wishlistId": "4",
+ "wishlistId": 4,
"name": "xyz789",
"visibility": "PUBLIC"
}
@@ -20326,8 +21011,8 @@ Response
{
"data": {
"updateWishlist": {
- "name": "xyz789",
- "uid": 4,
+ "name": "abc123",
+ "uid": "4",
"visibility": "PUBLIC"
}
}
@@ -20450,7 +21135,7 @@ Fields
Example
- {"template_id": "4"}
+ {"template_id": 4}
@@ -20498,7 +21183,7 @@ Fields
Example
{
- "cart_id": "xyz789",
+ "cart_id": "abc123",
"cart_items": [BundleProductCartItemInput]
}
@@ -20674,7 +21359,7 @@ Fields
Example
{
- "cart_id": "xyz789",
+ "cart_id": "abc123",
"cart_items": [DownloadableProductCartItemInput]
}
@@ -20779,9 +21464,9 @@ Example
"dynamic_attributes": [
GiftRegistryDynamicAttributeInput
],
- "email": "xyz789",
- "firstname": "xyz789",
- "lastname": "xyz789"
+ "email": "abc123",
+ "firstname": "abc123",
+ "lastname": "abc123"
}
@@ -20917,7 +21602,55 @@ Fields
Example
- {"products": [4], "uid": "4"}
+ {"products": ["4"], "uid": 4}
+
+
+
+ back to top
+
+
+
+
+ Types
+
+ AddProductsToNewCartOutput
+
+
+
+ Description
+ Contains details about the cart after adding products to it.
+
+
+ Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+ cart - Cart
+
+ The cart after products have been added.
+
+
+ user_errors - [CartUserInputError]
+
+ Contains errors encountered while adding an item to the cart.
+
+
+
+
+
+
+
+ Example
+ {
+ "cart": Cart,
+ "user_errors": [CartUserInputError]
+}
@@ -21054,7 +21787,7 @@ Fields
Example
{
"comment": "abc123",
- "purchase_order_uid": "4"
+ "purchase_order_uid": 4
}
@@ -21150,7 +21883,7 @@ Fields
Example
{
"cart_id": "abc123",
- "purchase_order_uid": 4,
+ "purchase_order_uid": "4",
"replace_existing_cart_items": false
}
@@ -21198,7 +21931,7 @@ Fields
Example
{
- "message": "abc123",
+ "message": "xyz789",
"type": "OUT_OF_STOCK"
}
@@ -21363,7 +22096,7 @@ Fields
Example
{
- "comment_text": "abc123",
+ "comment_text": "xyz789",
"return_uid": "4"
}
@@ -21558,7 +22291,7 @@ Fields
Example
{
- "cart_id": "abc123",
+ "cart_id": "xyz789",
"cart_items": [SimpleProductCartItemInput]
}
@@ -21744,7 +22477,7 @@ Example
"add_wishlist_items_to_cart_user_errors": [
WishlistCartUserInputError
],
- "status": false,
+ "status": true,
"wishlist": Wishlist
}
@@ -21808,10 +22541,10 @@ Fields
Example
{
"attribute_code": "xyz789",
- "count": 123,
- "label": "xyz789",
+ "count": 987,
+ "label": "abc123",
"options": [AggregationOption],
- "position": 123
+ "position": 987
}
@@ -21865,7 +22598,7 @@ Example
{
"count": 987,
"label": "abc123",
- "value": "abc123"
+ "value": "xyz789"
}
@@ -21935,7 +22668,7 @@ Possible Types
Example
{
"count": 987,
- "label": "xyz789",
+ "label": "abc123",
"value": "abc123"
}
@@ -21978,7 +22711,7 @@ Fields
Example
- {"includeDirectChildrenOnly": false}
+ {"includeDirectChildrenOnly": true}
@@ -22094,8 +22827,8 @@ Example
"button_styles": ButtonStyles,
"code": "abc123",
"is_visible": true,
- "payment_intent": "abc123",
- "payment_source": "xyz789",
+ "payment_intent": "xyz789",
+ "payment_source": "abc123",
"sdk_params": [SDKParams],
"sort_order": "abc123",
"title": "abc123"
@@ -22154,8 +22887,8 @@ Fields
Example
{
"payment_source": "xyz789",
- "payments_order_id": "abc123",
- "paypal_order_id": "abc123"
+ "payments_order_id": "xyz789",
+ "paypal_order_id": "xyz789"
}
@@ -22196,7 +22929,7 @@ Fields
Example
- {"code": "xyz789"}
+ {"code": "abc123"}
@@ -22358,7 +23091,7 @@ Fields
Example
{
- "cart_id": "xyz789",
+ "cart_id": "abc123",
"coupon_code": "xyz789"
}
@@ -22503,7 +23236,7 @@ Fields
Example
{
- "cart_id": "xyz789",
+ "cart_id": "abc123",
"coupon_codes": ["xyz789"],
"type": "APPEND"
}
@@ -22555,7 +23288,7 @@ Fields
Example
{
"cart_id": "xyz789",
- "gift_card_code": "abc123"
+ "gift_card_code": "xyz789"
}
@@ -22725,7 +23458,7 @@ Fields
Example
- {"cart_id": "abc123"}
+ {"cart_id": "xyz789"}
@@ -22812,7 +23545,7 @@ Fields
Example
- {"radius": 987, "search_term": "xyz789"}
+ {"radius": 987, "search_term": "abc123"}
@@ -22857,7 +23590,7 @@ Fields
Example
- {"compare_list": CompareList, "result": false}
+ {"compare_list": CompareList, "result": true}
@@ -23107,18 +23840,18 @@ Fields
Example
{
- "is_comparable": false,
+ "is_comparable": true,
"is_filterable": true,
- "is_filterable_in_search": false,
- "is_html_allowed_on_front": false,
- "is_searchable": true,
- "is_used_for_customer_segment": false,
+ "is_filterable_in_search": true,
+ "is_html_allowed_on_front": true,
+ "is_searchable": false,
+ "is_used_for_customer_segment": true,
"is_used_for_price_rules": true,
- "is_used_for_promo_rules": true,
+ "is_used_for_promo_rules": false,
"is_visible_in_advanced_search": false,
"is_visible_on_front": true,
- "is_wysiwyg_enabled": true,
- "used_in_product_listing": true
+ "is_wysiwyg_enabled": false,
+ "used_in_product_listing": false
}
@@ -23314,8 +24047,8 @@ Fields
Example
{
- "attribute_code": "xyz789",
- "entity_type": "xyz789"
+ "attribute_code": "abc123",
+ "entity_type": "abc123"
}
@@ -23357,7 +24090,7 @@ Fields
Example
- {"value": "xyz789"}
+ {"value": "abc123"}
@@ -23443,8 +24176,8 @@ Example
"entity_type": "CATALOG_PRODUCT",
"frontend_class": "abc123",
"frontend_input": "BOOLEAN",
- "is_required": false,
- "is_unique": false,
+ "is_required": true,
+ "is_unique": true,
"label": "xyz789",
"options": [CustomAttributeOptionInterface]
}
@@ -23493,7 +24226,7 @@ Fields
Example
{
- "message": "xyz789",
+ "message": "abc123",
"type": "ENTITY_NOT_FOUND"
}
@@ -23600,7 +24333,7 @@ Fields
Example
{
- "label": "abc123",
+ "label": "xyz789",
"value": "xyz789"
}
@@ -23654,8 +24387,8 @@ Fields
Example
{
"is_default": true,
- "label": "abc123",
- "value": "abc123"
+ "label": "xyz789",
+ "value": "xyz789"
}
@@ -23699,7 +24432,7 @@ Fields
Example
{
"label": "xyz789",
- "value": "abc123"
+ "value": "xyz789"
}
@@ -23847,7 +24580,10 @@ Fields
Example
- {"code": 4, "value": "abc123"}
+ {
+ "code": "4",
+ "value": "xyz789"
+}
@@ -23901,7 +24637,7 @@ Fields
Example
{
- "attribute_code": "abc123",
+ "attribute_code": "xyz789",
"selected_options": [AttributeInputSelectedOption],
"value": "abc123"
}
@@ -23955,6 +24691,11 @@ Possible Types
Fields
Example
-{"code": "AFN", "symbol": "xyz789"}
+ {"code": "AFN", "symbol": "abc123"}
Fields
Example
{
"code": "xyz789",
- "is_deferred": true,
+ "is_deferred": false,
"title": "abc123"
}
@@ -24248,11 +24989,11 @@ Example
"amount": Money, "available": false, "base_amount": Money, - "carrier_code": "xyz789", + "carrier_code": "abc123", "carrier_title": "abc123", "error_message": "xyz789", - "method_code": "xyz789", - "method_title": "xyz789", + "method_code": "abc123", + "method_title": "abc123", "price_excl_tax": Money, "price_incl_tax": Money } @@ -24347,6 +25088,12 @@Fields
customer_address_uid - ID
+ same_as_shipping - Boolean
@@ -24369,6 +25116,7 @@ Example
{
"address": CartAddressInput,
"customer_address_id": 123,
+ "customer_address_uid": 4,
"same_as_shipping": true,
"use_for_shipping": true
}
@@ -24443,11 +25191,11 @@ Fields
Example
{
- "address_line_1": "xyz789",
- "address_line_2": "xyz789",
- "city": "abc123",
- "country_code": "xyz789",
- "postal_code": "xyz789",
+ "address_line_1": "abc123",
+ "address_line_2": "abc123",
+ "city": "xyz789",
+ "country_code": "abc123",
+ "postal_code": "abc123",
"region": "xyz789"
}
@@ -24497,6 +25245,11 @@ Fields
customer_address_uid - ID
+ customer_notes - String
Fields
id - Int
+ id - Int
+ customer_address_uid instead.
lastname - String!
@@ -24560,9 +25314,9 @@ Fields
uid - String!
+ uid - ID!
vat_id - String
@@ -24577,23 +25331,24 @@ Fields
Example
{
- "city": "xyz789",
+ "city": "abc123",
"company": "xyz789",
"country": CartAddressCountry,
"custom_attributes": [AttributeValueInterface],
+ "customer_address_uid": "4",
"customer_notes": "abc123",
"fax": "abc123",
- "firstname": "xyz789",
+ "firstname": "abc123",
"id": 123,
"lastname": "abc123",
"middlename": "abc123",
"postcode": "xyz789",
- "prefix": "abc123",
+ "prefix": "xyz789",
"region": CartAddressRegion,
"street": ["xyz789"],
- "suffix": "abc123",
- "telephone": "abc123",
- "uid": "xyz789",
+ "suffix": "xyz789",
+ "telephone": "xyz789",
+ "uid": "4",
"vat_id": "xyz789"
}
@@ -24615,11 +25370,6 @@ Description
Example
-true
-
- Fields
Example
{
- "device_data": "xyz789",
- "public_hash": "abc123"
+ "device_data": "abc123",
+ "public_hash": "xyz789"
}
Example
{
"device_data": "xyz789",
"is_active_payment_token_enabler": true,
- "payment_method_nonce": "abc123"
+ "payment_method_nonce": "xyz789"
}
@@ -24834,7 +25584,7 @@ Fields
Example
{
"category_id": 987,
- "category_level": 123,
+ "category_level": 987,
"category_name": "xyz789",
"category_uid": 4,
"category_url_key": "abc123",
@@ -24974,8 +25724,8 @@ Example
"errors": [CartItemError],
"gift_message": GiftMessage,
"gift_wrapping": GiftWrapping,
- "id": "xyz789",
- "is_available": true,
+ "id": "abc123",
+ "is_available": false,
"max_qty": 987.65,
"min_qty": 987.65,
"not_available_message": "xyz789",
@@ -25067,7 +25817,7 @@ Example
"order_item": OrderItemInterface,
"product_name": "abc123",
"product_sale_price": Money,
- "product_sku": "xyz789",
+ "product_sku": "abc123",
"quantity_refunded": 123.45
}
@@ -25147,12 +25897,12 @@ Example
{
"bundle_options": [ItemSelectedBundleOption],
"discounts": [Discount],
- "id": "4",
+ "id": 4,
"order_item": OrderItemInterface,
- "product_name": "abc123",
+ "product_name": "xyz789",
"product_sale_price": Money,
- "product_sku": "xyz789",
- "quantity_invoiced": 987.65
+ "product_sku": "abc123",
+ "quantity_invoiced": 123.45
}
@@ -25235,13 +25985,13 @@ Fields
Example
{
- "option_id": 987,
+ "option_id": 123,
"options": [BundleItemOption],
"position": 123,
"price_range": PriceRange,
"required": false,
"sku": "abc123",
- "title": "abc123",
+ "title": "xyz789",
"type": "abc123",
"uid": 4
}
@@ -25337,17 +26087,17 @@ Fields
Example
{
- "can_change_quantity": false,
+ "can_change_quantity": true,
"id": 123,
"is_default": true,
"label": "abc123",
- "position": 123,
+ "position": 987,
"price": 123.45,
"price_type": "FIXED",
"product": ProductInterface,
- "qty": 123.45,
- "quantity": 123.45,
- "uid": "4"
+ "qty": 987.65,
+ "quantity": 987.65,
+ "uid": 4
}
@@ -25403,8 +26153,8 @@ Fields
Example
{
"id": 123,
- "quantity": 987.65,
- "value": ["xyz789"]
+ "quantity": 123.45,
+ "value": ["abc123"]
}
Example
{
"bundle_options": [ItemSelectedBundleOption],
"discounts": [Discount],
- "eligible_for_return": true,
+ "eligible_for_return": false,
"entered_options": [OrderItemOption],
"gift_message": GiftMessage,
"gift_wrapping": GiftWrapping,
@@ -25573,14 +26323,14 @@ Example
"product": ProductInterface,
"product_name": "xyz789",
"product_sale_price": Money,
- "product_sku": "abc123",
+ "product_sku": "xyz789",
"product_type": "xyz789",
- "product_url_key": "xyz789",
- "quantity_canceled": 987.65,
- "quantity_invoiced": 123.45,
- "quantity_ordered": 123.45,
- "quantity_refunded": 987.65,
- "quantity_return_requested": 123.45,
+ "product_url_key": "abc123",
+ "quantity_canceled": 123.45,
+ "quantity_invoiced": 987.65,
+ "quantity_ordered": 987.65,
+ "quantity_refunded": 123.45,
+ "quantity_return_requested": 987.65,
"quantity_returned": 123.45,
"quantity_shipped": 123.45,
"selected_options": [OrderItemOption],
@@ -25613,13 +26363,6 @@ Fields
activity - String
- custom_attributes field instead.
- attribute_set_id - Int
Fields
category_gear - String
- custom_attributes field instead.
- climate - String
- custom_attributes field instead.
- collar - String
- custom_attributes field instead.
- color - Int
filters
Indicates whether the bundle product has a dynamically calculated weight.
eco_collection - Int
- custom_attributes field instead.
- erin_recommends - Int
- custom_attributes field instead.
- features_bags - String
- custom_attributes field instead.
- format - Int
- custom_attributes field instead.
- gender - String
- custom_attributes field instead.
- gift_message_available - Boolean!
filters
A number representing the product's manufacturer. Use the custom_attributes field instead.
custom_attributes field instead.
material - String
- custom_attributes field instead.
- max_sale_qty - Float
filters
The product name. Customers use this name to identify the product.
new - Int
- custom_attributes field instead.
- new_from_date - String
filters
If the product has multiple options, determines where they appear on the product page.
pattern - String
- custom_attributes field instead.
- performance_fabric - Int
- custom_attributes field instead.
- price - ProductPrices
filters
An array of ProductLinks objects.
ProductLinks objects. purpose - Int
- custom_attributes field instead.
- quantity - Float
currentPage
rules - [CatalogRule]
- sale - Int
- custom_attributes field instead.
- ship_bundle_items - ShipBundleItemsEnum
currentPage
A short description of the product. Its use depends on the theme.
size - Int
- custom_attributes field instead.
- sku - String
sleeve - String
- custom_attributes field instead.
- small_image - ProductImage
currentPage
Stock status of the product
strap_bags - String
- custom_attributes field instead.
- style_bags - String
- custom_attributes field instead.
- style_bottom - String
- custom_attributes field instead.
- style_general - String
- custom_attributes field instead.
- swatch_image - String
currentPage
Example
{
- "activity": "abc123",
"attribute_set_id": 123,
- "canonical_url": "xyz789",
+ "canonical_url": "abc123",
"categories": [CategoryInterface],
- "category_gear": "abc123",
- "climate": "abc123",
- "collar": "abc123",
- "color": 987,
+ "color": 123,
"country_of_manufacture": "xyz789",
"created_at": "xyz789",
"crosssell_products": [ProductInterface],
"custom_attributesV2": ProductCustomAttributes,
"description": ComplexTextValue,
"dynamic_price": false,
- "dynamic_sku": true,
+ "dynamic_sku": false,
"dynamic_weight": false,
- "eco_collection": 987,
- "erin_recommends": 123,
- "features_bags": "abc123",
- "format": 123,
- "gender": "abc123",
"gift_message_available": false,
- "gift_wrapping_available": true,
+ "gift_wrapping_available": false,
"gift_wrapping_price": Money,
"id": 123,
"image": ProductImage,
- "is_returnable": "xyz789",
+ "is_returnable": "abc123",
"items": [BundleItem],
"manufacturer": 123,
- "material": "abc123",
"max_sale_qty": 987.65,
"media_gallery": [MediaGalleryInterface],
"media_gallery_entries": [MediaGalleryEntry],
- "meta_description": "abc123",
+ "meta_description": "xyz789",
"meta_keyword": "abc123",
- "meta_title": "xyz789",
- "min_sale_qty": 123.45,
- "name": "xyz789",
- "new": 987,
- "new_from_date": "abc123",
+ "meta_title": "abc123",
+ "min_sale_qty": 987.65,
+ "name": "abc123",
+ "new_from_date": "xyz789",
"new_to_date": "xyz789",
"only_x_left_in_stock": 987.65,
"options": [CustomizableOptionInterface],
"options_container": "xyz789",
- "pattern": "abc123",
- "performance_fabric": 987,
"price": ProductPrices,
"price_details": PriceDetails,
"price_range": PriceRange,
"price_tiers": [TierPrice],
"price_view": "PRICE_RANGE",
"product_links": [ProductLinksInterface],
- "purpose": 987,
"quantity": 123.45,
"rating_summary": 987.65,
"redirect_code": 123,
@@ -26231,38 +26815,30 @@ Example
"relative_url": "abc123",
"review_count": 987,
"reviews": ProductReviews,
- "rules": [CatalogRule],
- "sale": 987,
"ship_bundle_items": "TOGETHER",
"short_description": ComplexTextValue,
- "size": 987,
"sku": "xyz789",
- "sleeve": "xyz789",
"small_image": ProductImage,
"special_from_date": "xyz789",
"special_price": 987.65,
"special_to_date": "xyz789",
- "staged": false,
+ "staged": true,
"stock_status": "IN_STOCK",
- "strap_bags": "xyz789",
- "style_bags": "abc123",
- "style_bottom": "xyz789",
- "style_general": "xyz789",
- "swatch_image": "abc123",
+ "swatch_image": "xyz789",
"thumbnail": ProductImage,
"tier_price": 123.45,
"tier_prices": [ProductTierPrices],
"type": "CMS_PAGE",
- "type_id": "xyz789",
+ "type_id": "abc123",
"uid": "4",
- "updated_at": "abc123",
+ "updated_at": "xyz789",
"upsell_products": [ProductInterface],
- "url_key": "abc123",
+ "url_key": "xyz789",
"url_path": "xyz789",
"url_rewrites": [UrlRewrite],
"url_suffix": "xyz789",
"websites": [Website],
- "weight": 987.65
+ "weight": 123.45
}
@@ -26385,7 +26961,7 @@ Example
"customizable_options": [SelectedCustomizableOption],
"product": ProductInterface,
"quantity": 123.45,
- "uid": 4
+ "uid": "4"
}
@@ -26460,7 +27036,7 @@ Example
"bundle_options": [ItemSelectedBundleOption],
"id": "4",
"order_item": OrderItemInterface,
- "product_name": "xyz789",
+ "product_name": "abc123",
"product_sale_price": Money,
"product_sku": "xyz789",
"quantity_shipped": 987.65
@@ -26538,8 +27114,8 @@ Example
"added_at": "abc123",
"bundle_options": [SelectedBundleOption],
"customizable_options": [SelectedCustomizableOption],
- "description": "abc123",
- "id": "4",
+ "description": "xyz789",
+ "id": 4,
"product": ProductInterface,
"quantity": 123.45
}
@@ -26609,11 +27185,11 @@ Fields
Example
{
- "color": "xyz789",
+ "color": "abc123",
"height": 987,
"label": "abc123",
- "layout": "abc123",
- "shape": "xyz789",
+ "layout": "xyz789",
+ "shape": "abc123",
"tagline": true,
"use_default_height": true
}
@@ -26832,7 +27408,7 @@ Fields
Example
{
"order_id": "4",
- "reason": "abc123"
+ "reason": "xyz789"
}
@@ -26925,7 +27501,7 @@ Fields
Example
- {"description": "abc123"}
+ {"description": "xyz789"}
@@ -26984,9 +27560,9 @@ Example
{
"bin_details": CardBin,
"card_expiry_month": "abc123",
- "card_expiry_year": "abc123",
- "last_digits": "xyz789",
- "name": "xyz789"
+ "card_expiry_year": "xyz789",
+ "last_digits": "abc123",
+ "name": "abc123"
}
@@ -27023,7 +27599,7 @@ Fields
Example
- {"bin": "abc123"}
+ {"bin": "xyz789"}
@@ -27072,7 +27648,7 @@ Fields
Example
{
"billing_address": BillingAddressPaymentSourceInput,
- "name": "abc123"
+ "name": "xyz789"
}
@@ -27124,7 +27700,7 @@ Fields
Example
{
- "brand": "xyz789",
+ "brand": "abc123",
"expiry": "xyz789",
"last_digits": "xyz789"
}
@@ -27271,7 +27847,7 @@ sort Indicates whether the shopper requested a printed card for the cart.
Example
{
- "activity": "abc123",
"attribute_set_id": 123,
- "canonical_url": "xyz789",
+ "canonical_url": "abc123",
"categories": [CategoryInterface],
- "category_gear": "abc123",
- "climate": "abc123",
- "collar": "abc123",
- "color": 987,
+ "color": 123,
"country_of_manufacture": "xyz789",
"created_at": "xyz789",
"crosssell_products": [ProductInterface],
"custom_attributesV2": ProductCustomAttributes,
"description": ComplexTextValue,
"dynamic_price": false,
- "dynamic_sku": true,
+ "dynamic_sku": false,
"dynamic_weight": false,
- "eco_collection": 987,
- "erin_recommends": 123,
- "features_bags": "abc123",
- "format": 123,
- "gender": "abc123",
"gift_message_available": false,
- "gift_wrapping_available": true,
+ "gift_wrapping_available": false,
"gift_wrapping_price": Money,
"id": 123,
"image": ProductImage,
- "is_returnable": "xyz789",
+ "is_returnable": "abc123",
"items": [BundleItem],
"manufacturer": 123,
- "material": "abc123",
"max_sale_qty": 987.65,
"media_gallery": [MediaGalleryInterface],
"media_gallery_entries": [MediaGalleryEntry],
- "meta_description": "abc123",
+ "meta_description": "xyz789",
"meta_keyword": "abc123",
- "meta_title": "xyz789",
- "min_sale_qty": 123.45,
- "name": "xyz789",
- "new": 987,
- "new_from_date": "abc123",
+ "meta_title": "abc123",
+ "min_sale_qty": 987.65,
+ "name": "abc123",
+ "new_from_date": "xyz789",
"new_to_date": "xyz789",
"only_x_left_in_stock": 987.65,
"options": [CustomizableOptionInterface],
"options_container": "xyz789",
- "pattern": "abc123",
- "performance_fabric": 987,
"price": ProductPrices,
"price_details": PriceDetails,
"price_range": PriceRange,
"price_tiers": [TierPrice],
"price_view": "PRICE_RANGE",
"product_links": [ProductLinksInterface],
- "purpose": 987,
"quantity": 123.45,
"rating_summary": 987.65,
"redirect_code": 123,
@@ -26231,38 +26815,30 @@ Example
"relative_url": "abc123",
"review_count": 987,
"reviews": ProductReviews,
- "rules": [CatalogRule],
- "sale": 987,
"ship_bundle_items": "TOGETHER",
"short_description": ComplexTextValue,
- "size": 987,
"sku": "xyz789",
- "sleeve": "xyz789",
"small_image": ProductImage,
"special_from_date": "xyz789",
"special_price": 987.65,
"special_to_date": "xyz789",
- "staged": false,
+ "staged": true,
"stock_status": "IN_STOCK",
- "strap_bags": "xyz789",
- "style_bags": "abc123",
- "style_bottom": "xyz789",
- "style_general": "xyz789",
- "swatch_image": "abc123",
+ "swatch_image": "xyz789",
"thumbnail": ProductImage,
"tier_price": 123.45,
"tier_prices": [ProductTierPrices],
"type": "CMS_PAGE",
- "type_id": "xyz789",
+ "type_id": "abc123",
"uid": "4",
- "updated_at": "abc123",
+ "updated_at": "xyz789",
"upsell_products": [ProductInterface],
- "url_key": "abc123",
+ "url_key": "xyz789",
"url_path": "xyz789",
"url_rewrites": [UrlRewrite],
"url_suffix": "xyz789",
"websites": [Website],
- "weight": 987.65
+ "weight": 123.45
}
@@ -26385,7 +26961,7 @@ Example
"customizable_options": [SelectedCustomizableOption], "product": ProductInterface, "quantity": 123.45, - "uid": 4 + "uid": "4" }Example
{
- "color": "xyz789",
+ "color": "abc123",
"height": 987,
"label": "abc123",
- "layout": "abc123",
- "shape": "xyz789",
+ "layout": "xyz789",
+ "shape": "abc123",
"tagline": true,
"use_default_height": true
}
@@ -26832,7 +27408,7 @@ Fields
Example
{
"order_id": "4",
- "reason": "abc123"
+ "reason": "xyz789"
}
Example
-{"description": "abc123"}
+ {"description": "xyz789"}
{
"bin_details": CardBin,
"card_expiry_month": "abc123",
- "card_expiry_year": "abc123",
- "last_digits": "xyz789",
- "name": "xyz789"
+ "card_expiry_year": "xyz789",
+ "last_digits": "abc123",
+ "name": "abc123"
}
Example
-{"bin": "abc123"}
+ {"bin": "xyz789"}
{
"billing_address": BillingAddressPaymentSourceInput,
- "name": "abc123"
+ "name": "xyz789"
}
Example
{
- "brand": "xyz789",
+ "brand": "abc123",
"expiry": "xyz789",
"last_digits": "xyz789"
}
@@ -27271,7 +27847,7 @@ sort Indicates whether the shopper requested a printed card for the cart.
rules - [CartRule]
+ rules - [CartRuleStorefront]
Example
"available_gift_wrappings": [GiftWrapping], "available_payment_methods": [AvailablePaymentMethod], "billing_address": BillingCartAddress, - "email": "xyz789", + "email": "abc123", "gift_message": GiftMessage, "gift_receipt_included": false, "gift_wrapping": GiftWrapping, - "id": "4", - "is_virtual": false, + "id": 4, + "is_virtual": true, "items": [CartItemInterface], "itemsV2": CartItems, "prices": CartPrices, - "printed_card_included": true, - "rules": [CartRule], + "printed_card_included": false, + "rules": [CartRuleStorefront], "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], - "total_quantity": 987.65 + "total_quantity": 123.45 } @@ -27488,7 +28064,7 @@Fields
telephone - String
+ telephone - String!
Example
{
"city": "abc123",
"company": "xyz789",
- "country_code": "xyz789",
+ "country_code": "abc123",
"custom_attributes": [AttributeValueInput],
"fax": "xyz789",
"firstname": "xyz789",
- "lastname": "abc123",
- "middlename": "xyz789",
+ "lastname": "xyz789",
+ "middlename": "abc123",
"postcode": "xyz789",
"prefix": "xyz789",
- "region": "xyz789",
- "region_id": 123,
- "save_in_address_book": true,
+ "region": "abc123",
+ "region_id": 987,
+ "save_in_address_book": false,
"street": ["abc123"],
- "suffix": "abc123",
+ "suffix": "xyz789",
"telephone": "xyz789",
"vat_id": "xyz789"
}
@@ -27567,6 +28143,11 @@ Fields
The custom attribute values of the billing or shipping address.
+
+ customer_address_uid - ID
+
+ The unique ID from the customer's address book that uniquely identifies the address.
+
fax - String
@@ -27578,9 +28159,10 @@ Fields
The first name of the customer or guest.
- id - Int
+ id - Int
+
+ Id of the customer address. Use customer_address_uid instead.
- Id of the customer address.
lastname - String!
@@ -27623,9 +28205,9 @@ Fields
The telephone number for the billing or shipping address.
- uid - String!
+ uid - ID!
- The unique id of the customer address.
+ The unique id of the customer cart address.
vat_id - String
@@ -27662,23 +28244,24 @@ Possible Types
Example
{
- "city": "abc123",
+ "city": "xyz789",
"company": "abc123",
"country": CartAddressCountry,
"custom_attributes": [AttributeValueInterface],
+ "customer_address_uid": 4,
"fax": "xyz789",
"firstname": "xyz789",
"id": 987,
- "lastname": "abc123",
- "middlename": "abc123",
- "postcode": "xyz789",
- "prefix": "abc123",
+ "lastname": "xyz789",
+ "middlename": "xyz789",
+ "postcode": "abc123",
+ "prefix": "xyz789",
"region": CartAddressRegion,
- "street": ["abc123"],
- "suffix": "abc123",
- "telephone": "abc123",
- "uid": "xyz789",
- "vat_id": "abc123"
+ "street": ["xyz789"],
+ "suffix": "xyz789",
+ "telephone": "xyz789",
+ "uid": 4,
+ "vat_id": "xyz789"
}
@@ -27730,8 +28313,8 @@ Fields
Example
{
- "code": "xyz789",
- "label": "xyz789",
+ "code": "abc123",
+ "label": "abc123",
"region_id": 123
}
@@ -27988,7 +28571,7 @@ Example
"entered_options": [EnteredOptionInput],
"parent_sku": "abc123",
"quantity": 123.45,
- "selected_options": [4],
+ "selected_options": ["4"],
"sku": "abc123"
}
@@ -28114,12 +28697,12 @@ Possible Types
-
+
-
+
@@ -28137,16 +28720,16 @@ Example
{
"discount": [Discount],
"errors": [CartItemError],
- "id": "abc123",
- "is_available": true,
+ "id": "xyz789",
+ "is_available": false,
"max_qty": 123.45,
- "min_qty": 123.45,
+ "min_qty": 987.65,
"not_available_message": "xyz789",
"note_from_buyer": [ItemNote],
"note_from_seller": [ItemNote],
"prices": CartItemPrices,
"product": ProductInterface,
- "quantity": 123.45,
+ "quantity": 987.65,
"uid": 4
}
@@ -28299,7 +28882,7 @@ Fields
Example
- {"cart_item_id": 123, "quantity": 123.45}
+ {"cart_item_id": 987, "quantity": 987.65}
@@ -28351,7 +28934,7 @@ Fields
Example
{
"type": "FIXED",
- "units": "abc123",
+ "units": "xyz789",
"value": 123.45
}
@@ -28426,10 +29009,10 @@ Fields
Example
{
"cart_item_id": 123,
- "cart_item_uid": "4",
+ "cart_item_uid": 4,
"customizable_options": [CustomizableOptionInput],
"gift_message": GiftMessageInput,
- "gift_wrapping_id": "4",
+ "gift_wrapping_id": 4,
"quantity": 123.45
}
@@ -28580,11 +29163,11 @@ Example
back to top
-
+
- CartRule
+ CartRuleStorefront
@@ -28598,9 +29181,9 @@ Fields
- name - String!
+ uid - ID!
- Name of the cart price rule
+ The unique ID for a CartRule object.
@@ -28609,7 +29192,7 @@ Fields
Example
- {"name": "abc123"}
+ {"uid": 4}
@@ -29025,66 +29608,30 @@ Fields
Example
{
"apply_to": ["SIMPLE"],
- "code": 4,
+ "code": "4",
"default_value": "xyz789",
"entity_type": "CATALOG_PRODUCT",
- "frontend_class": "abc123",
+ "frontend_class": "xyz789",
"frontend_input": "BOOLEAN",
- "is_comparable": false,
- "is_filterable": false,
+ "is_comparable": true,
+ "is_filterable": true,
"is_filterable_in_search": false,
- "is_html_allowed_on_front": true,
- "is_required": false,
+ "is_html_allowed_on_front": false,
+ "is_required": true,
"is_searchable": false,
- "is_unique": false,
- "is_used_for_price_rules": true,
- "is_used_for_promo_rules": true,
- "is_visible_in_advanced_search": false,
+ "is_unique": true,
+ "is_used_for_price_rules": false,
+ "is_used_for_promo_rules": false,
+ "is_visible_in_advanced_search": true,
"is_visible_on_front": false,
"is_wysiwyg_enabled": false,
"label": "xyz789",
"options": [CustomAttributeOptionInterface],
"swatch_input_type": "BOOLEAN",
- "update_product_preview_image": false,
+ "update_product_preview_image": true,
"use_product_image_for_swatch": false,
"used_in_product_listing": false
}
-
-
-
- back to top
-
-
-
-
- Types
-
- CatalogRule
-
-
-
- Fields
-
-
-
- Field Name
- Description
-
-
-
-
- name - String!
-
- Name of the catalog rule
-
-
-
-
-
-
-
- Example
- {"name": "xyz789"}
@@ -29427,39 +29974,39 @@ Possible Types
Example
{
- "automatic_sorting": "abc123",
- "available_sort_by": ["abc123"],
+ "automatic_sorting": "xyz789",
+ "available_sort_by": ["xyz789"],
"breadcrumbs": [Breadcrumb],
"canonical_url": "xyz789",
"children_count": "abc123",
"cms_block": CmsBlock,
- "created_at": "abc123",
- "custom_layout_update_file": "abc123",
- "default_sort_by": "abc123",
- "description": "xyz789",
- "display_mode": "abc123",
- "filter_price_range": 987.65,
+ "created_at": "xyz789",
+ "custom_layout_update_file": "xyz789",
+ "default_sort_by": "xyz789",
+ "description": "abc123",
+ "display_mode": "xyz789",
+ "filter_price_range": 123.45,
"id": 987,
- "image": "abc123",
- "include_in_menu": 987,
- "is_anchor": 123,
- "landing_page": 123,
+ "image": "xyz789",
+ "include_in_menu": 123,
+ "is_anchor": 987,
+ "landing_page": 987,
"level": 987,
- "meta_description": "xyz789",
- "meta_keywords": "abc123",
- "meta_title": "abc123",
- "name": "abc123",
- "path": "abc123",
+ "meta_description": "abc123",
+ "meta_keywords": "xyz789",
+ "meta_title": "xyz789",
+ "name": "xyz789",
+ "path": "xyz789",
"path_in_store": "xyz789",
"position": 987,
"product_count": 987,
"products": CategoryProducts,
- "staged": false,
- "uid": "4",
+ "staged": true,
+ "uid": 4,
"updated_at": "abc123",
- "url_key": "abc123",
+ "url_key": "xyz789",
"url_path": "xyz789",
- "url_suffix": "xyz789"
+ "url_suffix": "abc123"
}
@@ -29567,7 +30114,7 @@ Example
{
"items": [CategoryTree],
"page_info": SearchResultPageInfo,
- "total_count": 987
+ "total_count": 123
}
@@ -29829,43 +30376,43 @@ sort
Example
{
- "automatic_sorting": "abc123",
+ "automatic_sorting": "xyz789",
"available_sort_by": ["abc123"],
"breadcrumbs": [Breadcrumb],
- "canonical_url": "xyz789",
+ "canonical_url": "abc123",
"children": [CategoryTree],
"children_count": "abc123",
"cms_block": CmsBlock,
- "created_at": "abc123",
+ "created_at": "xyz789",
"custom_layout_update_file": "abc123",
"default_sort_by": "xyz789",
- "description": "abc123",
- "display_mode": "xyz789",
- "filter_price_range": 123.45,
- "id": 123,
+ "description": "xyz789",
+ "display_mode": "abc123",
+ "filter_price_range": 987.65,
+ "id": 987,
"image": "abc123",
- "include_in_menu": 987,
- "is_anchor": 123,
- "landing_page": 123,
+ "include_in_menu": 123,
+ "is_anchor": 987,
+ "landing_page": 987,
"level": 987,
- "meta_description": "xyz789",
+ "meta_description": "abc123",
"meta_keywords": "xyz789",
- "meta_title": "xyz789",
+ "meta_title": "abc123",
"name": "xyz789",
"path": "abc123",
"path_in_store": "abc123",
"position": 987,
"product_count": 123,
"products": CategoryProducts,
- "redirect_code": 123,
- "relative_url": "xyz789",
+ "redirect_code": 987,
+ "relative_url": "abc123",
"staged": true,
"type": "CMS_PAGE",
"uid": 4,
- "updated_at": "abc123",
+ "updated_at": "xyz789",
"url_key": "abc123",
- "url_path": "abc123",
- "url_suffix": "abc123"
+ "url_path": "xyz789",
+ "url_suffix": "xyz789"
}
@@ -29937,13 +30484,13 @@ Fields
Example
{
- "agreement_id": 987,
+ "agreement_id": 123,
"checkbox_text": "abc123",
- "content": "xyz789",
+ "content": "abc123",
"content_height": "abc123",
"is_html": false,
"mode": "AUTO",
- "name": "xyz789"
+ "name": "abc123"
}
@@ -30044,7 +30591,7 @@ Example
{
"code": "REORDER_NOT_AVAILABLE",
"message": "abc123",
- "path": ["xyz789"]
+ "path": ["abc123"]
}
@@ -30256,7 +30803,7 @@ Fields
Example
- {"uid": 4}
+ {"uid": "4"}
@@ -30441,7 +30988,7 @@ Fields
Example
{
"errors": [NegotiableQuoteInvalidStateError],
- "quote_uid": "4"
+ "quote_uid": 4
}
@@ -30667,7 +31214,7 @@ Fields
Example
{
"content": "xyz789",
- "identifier": "abc123",
+ "identifier": "xyz789",
"title": "xyz789"
}
@@ -30805,18 +31352,18 @@ Fields
Example
{
- "content": "xyz789",
+ "content": "abc123",
"content_heading": "abc123",
"identifier": "abc123",
- "meta_description": "xyz789",
+ "meta_description": "abc123",
"meta_keywords": "abc123",
- "meta_title": "abc123",
+ "meta_title": "xyz789",
"page_layout": "abc123",
- "redirect_code": 987,
- "relative_url": "xyz789",
+ "redirect_code": 123,
+ "relative_url": "abc123",
"title": "abc123",
"type": "CMS_PAGE",
- "url_key": "xyz789"
+ "url_key": "abc123"
}
@@ -31201,9 +31748,9 @@ Example
"email": "xyz789",
"id": 4,
"legal_address": CompanyLegalAddress,
- "legal_name": "xyz789",
- "name": "xyz789",
- "payment_methods": ["xyz789"],
+ "legal_name": "abc123",
+ "name": "abc123",
+ "payment_methods": ["abc123"],
"reseller_id": "abc123",
"role": CompanyRole,
"roles": CompanyRoles,
@@ -31212,7 +31759,7 @@ Example
"team": CompanyTeam,
"user": Customer,
"users": CompanyUsers,
- "vat_tax_id": "xyz789"
+ "vat_tax_id": "abc123"
}
@@ -31271,7 +31818,7 @@ Example
{
"children": [CompanyAclResource],
"id": "4",
- "sort_order": 123,
+ "sort_order": 987,
"text": "abc123"
}
@@ -31352,11 +31899,11 @@ Fields
Example
{
"custom_attributes": [AttributeValueInput],
- "email": "xyz789",
- "firstname": "abc123",
- "gender": 987,
+ "email": "abc123",
+ "firstname": "xyz789",
+ "gender": 123,
"job_title": "xyz789",
- "lastname": "abc123",
+ "lastname": "xyz789",
"telephone": "xyz789"
}
@@ -31401,6 +31948,11 @@ Fields
The name of the company.
+
+ status - CompanyStatusEnum
+
+ The current status of the company.
+
@@ -31410,8 +31962,9 @@ Fields
Example
{
"id": "4",
- "legal_name": "abc123",
- "name": "xyz789"
+ "legal_name": "xyz789",
+ "name": "xyz789",
+ "status": "PENDING"
}
@@ -31494,9 +32047,9 @@ Example
"company_email": "abc123", "company_name": "xyz789", "legal_address": CompanyLegalAddressCreateInput, - "legal_name": "abc123", + "legal_name": "xyz789", "reseller_id": "abc123", - "vat_tax_id": "xyz789" + "vat_tax_id": "abc123" }Example
{
- "custom_reference_number": "abc123",
+ "custom_reference_number": "xyz789",
"operation_type": "ALLOCATION",
- "updated_by": "xyz789"
+ "updated_by": "abc123"
}
{
"code": "abc123",
- "role_id": 4,
+ "role_id": "4",
"user": CompanyInvitationUserInput
}
Example
{
- "company_id": "4",
+ "company_id": 4,
"customer_id": 4,
"job_title": "xyz789",
"status": "ACTIVE",
@@ -32131,12 +32684,12 @@ Fields
Example
{
- "city": "xyz789",
+ "city": "abc123",
"country_code": "AF",
"postcode": "xyz789",
"region": CustomerAddressRegion,
- "street": ["abc123"],
- "telephone": "xyz789"
+ "street": ["xyz789"],
+ "telephone": "abc123"
}
@@ -32209,7 +32762,7 @@ Fields
Example
{
- "city": "xyz789",
+ "city": "abc123",
"country_id": "AF",
"postcode": "xyz789",
"region": CustomerAddressRegionInput,
@@ -32291,7 +32844,7 @@ Example
"country_id": "AF",
"postcode": "xyz789",
"region": CustomerAddressRegionInput,
- "street": ["xyz789"],
+ "street": ["abc123"],
"telephone": "abc123"
}
@@ -32350,7 +32903,7 @@ Fields
Example
{
"id": "4",
- "name": "abc123",
+ "name": "xyz789",
"permissions": [CompanyAclResource],
"users_count": 987
}
@@ -32401,8 +32954,8 @@ Fields
Example
{
- "name": "xyz789",
- "permissions": ["abc123"]
+ "name": "abc123",
+ "permissions": ["xyz789"]
}
@@ -32457,8 +33010,8 @@ Fields
Example
{
- "id": "4",
- "name": "abc123",
+ "id": 4,
+ "name": "xyz789",
"permissions": ["abc123"]
}
@@ -32566,9 +33119,68 @@ Fields
Example
{
"email": "xyz789",
- "firstname": "abc123",
+ "firstname": "xyz789",
"lastname": "xyz789"
}
+
+
+
+ back to top
+ CompanyStatusEnum
+Description
+Defines the list of company status values.
+Values
+| Enum Value | +Description | +
|---|---|
|
+
|
+ Company is pending approval. | +
|
+
|
+ Company is approved. | +
|
+
|
+ Company is rejected. | +
|
+
|
+ Company is blocked. | +
Example
+"PENDING"
Fields
id - ID!
+ id - ID
CompanyTeam object. Example
{
"description": "xyz789",
"id": "4",
- "name": "abc123",
- "structure_id": "4"
+ "name": "xyz789",
+ "structure_id": 4
}
Fields
Example
{
- "description": "xyz789",
- "name": "abc123",
- "target_id": 4
+ "description": "abc123",
+ "name": "xyz789",
+ "target_id": "4"
}
Fields
Example
{
- "description": "xyz789",
- "id": "4",
+ "description": "abc123",
+ "id": 4,
"name": "xyz789"
}
@@ -32991,8 +33603,8 @@ Fields
Example
{
- "company_email": "abc123",
- "company_name": "xyz789",
+ "company_email": "xyz789",
+ "company_name": "abc123",
"legal_address": CompanyLegalAddressUpdateInput,
"legal_name": "xyz789",
"reseller_id": "abc123",
@@ -33081,14 +33693,14 @@ Fields
Example
{
- "email": "xyz789",
- "firstname": "abc123",
+ "email": "abc123",
+ "firstname": "xyz789",
"job_title": "xyz789",
- "lastname": "abc123",
- "role_id": 4,
+ "lastname": "xyz789",
+ "role_id": "4",
"status": "ACTIVE",
- "target_id": 4,
- "telephone": "xyz789"
+ "target_id": "4",
+ "telephone": "abc123"
}
@@ -33220,14 +33832,14 @@ Fields
Example
{
- "email": "xyz789",
- "firstname": "xyz789",
- "id": "4",
+ "email": "abc123",
+ "firstname": "abc123",
+ "id": 4,
"job_title": "abc123",
"lastname": "xyz789",
"role_id": 4,
"status": "ACTIVE",
- "telephone": "xyz789"
+ "telephone": "abc123"
}
@@ -33369,8 +33981,8 @@ Fields
Example
{
- "code": "abc123",
- "label": "abc123"
+ "code": "xyz789",
+ "label": "xyz789"
}
@@ -33482,9 +34094,59 @@ Fields
Example
{
"attributes": [ComparableAttribute],
- "item_count": 123,
+ "item_count": 987,
"items": [ComparableItem],
- "uid": "4"
+ "uid": 4
+}
+
+ CompleteOrderInput
+Description
+Update the quote and complete the order
+Example
+{
+ "cartId": "abc123",
+ "id": "xyz789"
}
Fields
Example
-{"html": "xyz789"}
+ {"html": "abc123"}
Fields
Example
{
- "code": "abc123",
- "label": "xyz789",
+ "code": "xyz789",
+ "label": "abc123",
"uid": "4",
- "value_index": 987
+ "value_index": 123
}
Example
"errors": [CartItemError], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": "abc123", - "is_available": false, - "max_qty": 987.65, - "min_qty": 123.45, - "not_available_message": "xyz789", + "id": "xyz789", + "is_available": true, + "max_qty": 123.45, + "min_qty": 987.65, + "not_available_message": "abc123", "note_from_buyer": [ItemNote], "note_from_seller": [ItemNote], "prices": CartItemPrices, @@ -33929,26 +34591,26 @@Fields
Example
{
"discounts": [Discount],
- "eligible_for_return": false,
+ "eligible_for_return": true,
"entered_options": [OrderItemOption],
"gift_message": GiftMessage,
"gift_wrapping": GiftWrapping,
- "id": "4",
- "parent_sku": "xyz789",
+ "id": 4,
+ "parent_sku": "abc123",
"prices": OrderItemPrices,
"product": ProductInterface,
- "product_name": "abc123",
+ "product_name": "xyz789",
"product_sale_price": Money,
"product_sku": "abc123",
- "product_type": "abc123",
+ "product_type": "xyz789",
"product_url_key": "abc123",
- "quantity_canceled": 987.65,
- "quantity_invoiced": 123.45,
+ "quantity_canceled": 123.45,
+ "quantity_invoiced": 987.65,
"quantity_ordered": 123.45,
- "quantity_refunded": 123.45,
+ "quantity_refunded": 987.65,
"quantity_return_requested": 123.45,
"quantity_returned": 987.65,
- "quantity_shipped": 987.65,
+ "quantity_shipped": 123.45,
"selected_options": [OrderItemOption],
"status": "xyz789"
}
@@ -33979,13 +34641,6 @@ Fields
-
- activity - String
-
-
- Use the custom_attributes field instead.
-
-
attribute_set_id - Int
@@ -34002,27 +34657,6 @@ Fields
The categories assigned to a product.
-
- category_gear - String
-
-
- Use the custom_attributes field instead.
-
-
-
- climate - String
-
-
- Use the custom_attributes field instead.
-
-
-
- collar - String
-
-
- Use the custom_attributes field instead.
-
-
color - Int
@@ -34092,41 +34726,6 @@ filters
Detailed information about the product. The value can include simple HTML tags.
-
- eco_collection - Int
-
-
- Use the custom_attributes field instead.
-
-
-
- erin_recommends - Int
-
-
- Use the custom_attributes field instead.
-
-
-
- features_bags - String
-
-
- Use the custom_attributes field instead.
-
-
-
- format - Int
-
-
- Use the custom_attributes field instead.
-
-
-
- gender - String
-
-
- Use the custom_attributes field instead.
-
-
gift_message_available - Boolean!
@@ -34164,13 +34763,6 @@ filters
A number representing the product's manufacturer. Use the custom_attributes field instead.
-
- material - String
-
-
- Use the custom_attributes field instead.
-
-
max_sale_qty - Float
@@ -34212,13 +34804,6 @@ filters
The product name. Customers use this name to identify the product.
-
- new - Int
-
-
- Use the custom_attributes field instead.
-
-
new_from_date - String
@@ -34244,20 +34829,6 @@ filters
If the product has multiple options, determines where they appear on the product page.
-
- pattern - String
-
-
- Use the custom_attributes field instead.
-
-
-
- performance_fabric - Int
-
-
- Use the custom_attributes field instead.
-
-
price - ProductPrices
@@ -34279,13 +34850,6 @@ filters
An array of ProductLinks objects.
-
- purpose - Int
-
-
- Use the custom_attributes field instead.
-
-
quantity - Float
@@ -34340,42 +34904,16 @@ currentPage
-
- rules - [CatalogRule]
-
- Provides applied catalog rules in the current active cart
-
-
- sale - Int
-
-
- Use the custom_attributes field instead.
-
-
short_description - ComplexTextValue
A short description of the product. Its use depends on the theme.
-
- size - Int
-
-
- Use the custom_attributes field instead.
-
-
sku - String
A number or code assigned to a product to identify the product, options, price, and manufacturer.
-
- sleeve - String
-
-
- Use the custom_attributes field instead.
-
-
small_image - ProductImage
@@ -34407,34 +34945,6 @@ currentPage
Stock status of the product
-
- strap_bags - String
-
-
- Use the custom_attributes field instead.
-
-
-
- style_bags - String
-
-
- Use the custom_attributes field instead.
-
-
-
- style_bottom - String
-
-
- Use the custom_attributes field instead.
-
-
-
- style_general - String
-
-
- Use the custom_attributes field instead.
-
-
swatch_image - String
@@ -34530,94 +35040,72 @@ currentPage
Example
{
- "activity": "xyz789",
- "attribute_set_id": 123,
+ "attribute_set_id": 987,
"canonical_url": "abc123",
"categories": [CategoryInterface],
- "category_gear": "xyz789",
- "climate": "xyz789",
- "collar": "abc123",
- "color": 123,
+ "color": 987,
"configurable_options": [ConfigurableProductOptions],
"configurable_product_options_selection": ConfigurableProductOptionsSelection,
"country_of_manufacture": "xyz789",
- "created_at": "abc123",
+ "created_at": "xyz789",
"crosssell_products": [ProductInterface],
"custom_attributesV2": ProductCustomAttributes,
"description": ComplexTextValue,
- "eco_collection": 123,
- "erin_recommends": 987,
- "features_bags": "xyz789",
- "format": 987,
- "gender": "abc123",
"gift_message_available": false,
"gift_wrapping_available": true,
"gift_wrapping_price": Money,
- "id": 987,
+ "id": 123,
"image": ProductImage,
- "is_returnable": "xyz789",
+ "is_returnable": "abc123",
"manufacturer": 987,
- "material": "abc123",
"max_sale_qty": 987.65,
"media_gallery": [MediaGalleryInterface],
"media_gallery_entries": [MediaGalleryEntry],
- "meta_description": "xyz789",
- "meta_keyword": "abc123",
- "meta_title": "xyz789",
+ "meta_description": "abc123",
+ "meta_keyword": "xyz789",
+ "meta_title": "abc123",
"min_sale_qty": 987.65,
- "name": "abc123",
- "new": 123,
+ "name": "xyz789",
"new_from_date": "abc123",
- "new_to_date": "xyz789",
- "only_x_left_in_stock": 123.45,
+ "new_to_date": "abc123",
+ "only_x_left_in_stock": 987.65,
"options": [CustomizableOptionInterface],
"options_container": "abc123",
- "pattern": "abc123",
- "performance_fabric": 987,
"price": ProductPrices,
"price_range": PriceRange,
"price_tiers": [TierPrice],
"product_links": [ProductLinksInterface],
- "purpose": 123,
- "quantity": 123.45,
+ "quantity": 987.65,
"rating_summary": 123.45,
- "redirect_code": 987,
+ "redirect_code": 123,
"related_products": [ProductInterface],
- "relative_url": "xyz789",
+ "relative_url": "abc123",
"review_count": 123,
"reviews": ProductReviews,
- "rules": [CatalogRule],
- "sale": 123,
"short_description": ComplexTextValue,
- "size": 123,
- "sku": "xyz789",
- "sleeve": "abc123",
+ "sku": "abc123",
"small_image": ProductImage,
"special_from_date": "xyz789",
- "special_price": 123.45,
- "special_to_date": "xyz789",
- "staged": true,
+ "special_price": 987.65,
+ "special_to_date": "abc123",
+ "staged": false,
"stock_status": "IN_STOCK",
- "strap_bags": "xyz789",
- "style_bags": "abc123",
- "style_bottom": "xyz789",
- "style_general": "abc123",
- "swatch_image": "xyz789",
+ "swatch_image": "abc123",
"thumbnail": ProductImage,
"tier_price": 987.65,
"tier_prices": [ProductTierPrices],
"type": "CMS_PAGE",
- "type_id": "abc123",
- "uid": 4,
+ "type_id": "xyz789",
+ "uid": "4",
"updated_at": "xyz789",
"upsell_products": [ProductInterface],
"url_key": "abc123",
"url_path": "xyz789",
"url_rewrites": [UrlRewrite],
- "url_suffix": "xyz789",
+ "url_suffix": "abc123",
"variants": [ConfigurableVariant],
"websites": [Website],
- "weight": 123.45
+ "weight": 987.65
}
@@ -34677,8 +35165,8 @@ Example
{
"customizable_options": [CustomizableOptionInput],
"data": CartItemInput,
- "parent_sku": "xyz789",
- "variant_sku": "abc123"
+ "parent_sku": "abc123",
+ "variant_sku": "xyz789"
}
@@ -34735,8 +35223,8 @@ Fields
Example
{
- "attribute_code": "xyz789",
- "label": "xyz789",
+ "attribute_code": "abc123",
+ "label": "abc123",
"uid": "4",
"values": [ConfigurableProductOptionValue]
}
@@ -34802,7 +35290,7 @@ Example
{
"is_available": false,
"is_use_default": false,
- "label": "abc123",
+ "label": "xyz789",
"swatch": SwatchDataInterface,
"uid": 4
}
@@ -34902,13 +35390,13 @@ Example
{
"attribute_code": "xyz789",
"attribute_id": "abc123",
- "attribute_id_v2": 987,
+ "attribute_id_v2": 123,
"attribute_uid": "4",
"id": 987,
- "label": "xyz789",
+ "label": "abc123",
"position": 987,
- "product_id": 123,
- "uid": 4,
+ "product_id": 987,
+ "uid": "4",
"use_default": true,
"values": [ConfigurableProductOptionsValues]
}
@@ -35045,13 +35533,13 @@ Fields
Example
{
- "default_label": "abc123",
- "label": "abc123",
- "store_label": "xyz789",
+ "default_label": "xyz789",
+ "label": "xyz789",
+ "store_label": "abc123",
"swatch_data": SwatchDataInterface,
- "uid": "4",
+ "uid": 4,
"use_default_value": true,
- "value_index": 987
+ "value_index": 123
}
@@ -35117,7 +35605,7 @@ Example
"customizable_options": [SelectedCustomizableOption],
"product": ProductInterface,
"quantity": 987.65,
- "uid": "4"
+ "uid": 4
}
@@ -35248,15 +35736,15 @@ Fields
Example
{
- "added_at": "xyz789",
+ "added_at": "abc123",
"child_sku": "abc123",
"configurable_options": [SelectedConfigurableOption],
"configured_variant": ProductInterface,
"customizable_options": [SelectedCustomizableOption],
"description": "abc123",
- "id": "4",
+ "id": 4,
"product": ProductInterface,
- "quantity": 123.45
+ "quantity": 987.65
}
@@ -35301,7 +35789,7 @@ Fields
Example
{
- "confirmation_key": "abc123",
+ "confirmation_key": "xyz789",
"order_id": 4
}
@@ -35398,7 +35886,7 @@ Fields
Example
{
"confirmation_key": "xyz789",
- "order_id": "4"
+ "order_id": 4
}
@@ -35502,8 +35990,8 @@ Fields
Example
{
- "comment": "xyz789",
- "email": "xyz789",
+ "comment": "abc123",
+ "email": "abc123",
"name": "abc123",
"telephone": "xyz789"
}
@@ -35744,11 +36232,11 @@ Fields
Example
{
"available_regions": [Region],
- "full_name_english": "abc123",
+ "full_name_english": "xyz789",
"full_name_locale": "abc123",
- "id": "xyz789",
- "three_letter_abbreviation": "xyz789",
- "two_letter_abbreviation": "xyz789"
+ "id": "abc123",
+ "three_letter_abbreviation": "abc123",
+ "two_letter_abbreviation": "abc123"
}
@@ -37542,9 +38030,9 @@ Example
"dynamic_attributes": [
GiftRegistryDynamicAttributeInput
],
- "event_name": "xyz789",
+ "event_name": "abc123",
"gift_registry_type_uid": "4",
- "message": "abc123",
+ "message": "xyz789",
"privacy_settings": "PRIVATE",
"registrants": [AddGiftRegistryRegistrantInput],
"shipping_address": GiftRegistryShippingAddressInput,
@@ -37724,9 +38212,9 @@ Fields
Example
{
"response_message": "xyz789",
- "result": 987,
- "result_code": 123,
- "secure_token": "xyz789",
+ "result": 123,
+ "result_code": 987,
+ "secure_token": "abc123",
"secure_token_id": "abc123"
}
@@ -37794,11 +38282,11 @@ Fields
Example
{
- "cartId": "abc123",
+ "cartId": "xyz789",
"location": "PRODUCT_DETAIL",
"methodCode": "abc123",
- "paymentSource": "abc123",
- "vaultIntent": true
+ "paymentSource": "xyz789",
+ "vaultIntent": false
}
@@ -37860,10 +38348,10 @@ Fields
Example
{
- "amount": 123.45,
+ "amount": 987.65,
"currency_code": "abc123",
- "id": "xyz789",
- "mp_order_id": "abc123",
+ "id": "abc123",
+ "mp_order_id": "xyz789",
"status": "xyz789"
}
@@ -37934,8 +38422,8 @@ Example
"nickname": "abc123",
"ratings": [ProductReviewRatingInput],
"sku": "xyz789",
- "summary": "xyz789",
- "text": "xyz789"
+ "summary": "abc123",
+ "text": "abc123"
}
@@ -38086,7 +38574,7 @@ Example
"amount": CreatePurchaseOrderApprovalRuleConditionAmountInput,
"attribute": "GRAND_TOTAL",
"operator": "MORE_THAN",
- "quantity": 987
+ "quantity": 123
}
@@ -38136,7 +38624,7 @@ Fields
Example
{
"description": "xyz789",
- "name": "abc123"
+ "name": "xyz789"
}
@@ -38514,7 +39002,7 @@ Example
{
"cc_exp_month": 123,
"cc_exp_year": 123,
- "cc_last_4": 987,
+ "cc_last_4": 123,
"cc_type": "xyz789"
}
@@ -38650,12 +39138,12 @@ Fields
Example
{
"discounts": [Discount],
- "id": 4,
+ "id": "4",
"order_item": OrderItemInterface,
- "product_name": "abc123",
+ "product_name": "xyz789",
"product_sale_price": Money,
"product_sku": "xyz789",
- "quantity_refunded": 987.65
+ "quantity_refunded": 123.45
}
@@ -38733,12 +39221,12 @@ Possible Types
-
+
-
+
@@ -38760,9 +39248,9 @@ Possible Types
Example
{
"discounts": [Discount],
- "id": 4,
+ "id": "4",
"order_item": OrderItemInterface,
- "product_name": "abc123",
+ "product_name": "xyz789",
"product_sale_price": Money,
"product_sku": "xyz789",
"quantity_refunded": 987.65
@@ -38934,10 +39422,10 @@ Example
{
"available_currency_codes": ["abc123"],
"base_currency_code": "abc123",
- "base_currency_symbol": "xyz789",
+ "base_currency_symbol": "abc123",
"default_display_currecy_code": "xyz789",
- "default_display_currecy_symbol": "xyz789",
- "default_display_currency_code": "xyz789",
+ "default_display_currecy_symbol": "abc123",
+ "default_display_currency_code": "abc123",
"default_display_currency_symbol": "abc123",
"exchange_rates": [ExchangeRate]
}
@@ -40319,9 +40807,9 @@ Possible Types
Example
{
"code": "4",
- "default_value": "xyz789",
+ "default_value": "abc123",
"entity_type": "CATALOG_PRODUCT",
- "frontend_class": "xyz789",
+ "frontend_class": "abc123",
"frontend_input": "BOOLEAN",
"is_required": false,
"is_unique": true,
@@ -40391,7 +40879,7 @@ Possible Types
Example
{
- "is_default": false,
+ "is_default": true,
"label": "xyz789",
"value": "xyz789"
}
@@ -40567,9 +41055,9 @@ giftRegistryUi
- group - CustomerGroup
+ group - CustomerGroupStorefront
- Name of the customer group assigned to the customer
+ Customer group assigned to the customer
group_id - Int
@@ -40579,10 +41067,9 @@ giftRegistryUi
- id - Int
-
- The ID assigned to the customer. id is not needed as part of Customer, because on the server side, it can be identified based on the customer token used for authentication. There is no need to know customer ID on the client side.
+ id - ID!
+ The unique ID assigned to the customer.
is_subscribed - Boolean
@@ -40849,7 +41336,7 @@ currentPage The role name and permissions assigned to the company user.
- segments - [CustomerSegment]
+ segments - [CustomerSegmentStorefront]
Customer segments associated with the current customer
@@ -40946,30 +41433,30 @@ Example
{
"addresses": [CustomerAddress],
"addressesV2": CustomerAddresses,
- "allow_remote_shopping_assistance": false,
+ "allow_remote_shopping_assistance": true,
"companies": UserCompaniesOutput,
"compare_list": CompareList,
"confirmation_status": "ACCOUNT_CONFIRMED",
"created_at": "xyz789",
"custom_attributes": [AttributeValueInterface],
- "date_of_birth": "xyz789",
- "default_billing": "xyz789",
+ "date_of_birth": "abc123",
+ "default_billing": "abc123",
"default_shipping": "xyz789",
"dob": "abc123",
- "email": "abc123",
+ "email": "xyz789",
"firstname": "abc123",
"gender": 123,
"gift_registries": [GiftRegistry],
"gift_registry": GiftRegistry,
- "group": CustomerGroup,
+ "group": CustomerGroupStorefront,
"group_id": 987,
- "id": 987,
+ "id": 4,
"is_subscribed": false,
"job_title": "xyz789",
"lastname": "abc123",
"middlename": "xyz789",
"orders": CustomerOrders,
- "prefix": "abc123",
+ "prefix": "xyz789",
"purchase_order": PurchaseOrder,
"purchase_order_approval_rule": PurchaseOrderApprovalRule,
"purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata,
@@ -40982,12 +41469,12 @@ Example
"reviews": ProductReviews,
"reward_points": RewardPoints,
"role": CompanyRole,
- "segments": [CustomerSegment],
+ "segments": [CustomerSegmentStorefront],
"status": "ACTIVE",
"store_credit": CustomerStoreCredit,
"structure_id": "4",
- "suffix": "abc123",
- "taxvat": "xyz789",
+ "suffix": "xyz789",
+ "taxvat": "abc123",
"team": CompanyTeam,
"telephone": "abc123",
"wishlist": Wishlist,
@@ -41099,9 +41586,10 @@ attributeCodes
The first name of the person associated with the shipping/billing address.
- id - Int
+ id - Int
+
+ The ID of a CustomerAddress object. Use uid instead.
- The ID of a CustomerAddress object.
lastname - String
@@ -41148,6 +41636,11 @@ attributeCodes
The customer's telephone number.
+
+ uid - ID
+
+ The unique ID for a CustomerAddress object.
+
vat_id - String
@@ -41161,29 +41654,30 @@ attributeCodes
Example
{
- "city": "abc123",
+ "city": "xyz789",
"company": "abc123",
"country_code": "AF",
- "country_id": "abc123",
+ "country_id": "xyz789",
"custom_attributes": [CustomerAddressAttribute],
"custom_attributesV2": [AttributeValueInterface],
- "customer_id": 123,
- "default_billing": false,
+ "customer_id": 987,
+ "default_billing": true,
"default_shipping": true,
"extension_attributes": [CustomerAddressAttribute],
"fax": "xyz789",
- "firstname": "abc123",
- "id": 123,
- "lastname": "abc123",
- "middlename": "abc123",
- "postcode": "abc123",
- "prefix": "abc123",
+ "firstname": "xyz789",
+ "id": 987,
+ "lastname": "xyz789",
+ "middlename": "xyz789",
+ "postcode": "xyz789",
+ "prefix": "xyz789",
"region": CustomerAddressRegion,
"region_id": 123,
"street": ["abc123"],
"suffix": "abc123",
- "telephone": "abc123",
- "vat_id": "abc123"
+ "telephone": "xyz789",
+ "uid": "4",
+ "vat_id": "xyz789"
}
@@ -41230,7 +41724,7 @@ Fields
Example
{
- "attribute_code": "xyz789",
+ "attribute_code": "abc123",
"value": "abc123"
}
@@ -41280,8 +41774,8 @@ Fields
Example
{
- "attribute_code": "abc123",
- "value": "abc123"
+ "attribute_code": "xyz789",
+ "value": "xyz789"
}
@@ -41440,19 +41934,19 @@ Example
"country_id": "AF",
"custom_attributes": [CustomerAddressAttributeInput],
"custom_attributesV2": [AttributeValueInput],
- "default_billing": false,
+ "default_billing": true,
"default_shipping": false,
- "fax": "xyz789",
- "firstname": "xyz789",
+ "fax": "abc123",
+ "firstname": "abc123",
"lastname": "abc123",
- "middlename": "xyz789",
+ "middlename": "abc123",
"postcode": "xyz789",
"prefix": "xyz789",
"region": CustomerAddressRegionInput,
"street": ["xyz789"],
"suffix": "xyz789",
"telephone": "xyz789",
- "vat_id": "abc123"
+ "vat_id": "xyz789"
}
@@ -41504,9 +41998,9 @@ Fields
Example
{
- "region": "xyz789",
- "region_code": "xyz789",
- "region_id": 123
+ "region": "abc123",
+ "region_code": "abc123",
+ "region_id": 987
}
@@ -41562,7 +42056,7 @@ Fields
Example
{
"region": "abc123",
- "region_code": "xyz789",
+ "region_code": "abc123",
"region_id": 123
}
@@ -41715,13 +42209,13 @@ Fields
Example
{
- "code": "4",
- "default_value": "abc123",
+ "code": 4,
+ "default_value": "xyz789",
"entity_type": "CATALOG_PRODUCT",
- "frontend_class": "abc123",
+ "frontend_class": "xyz789",
"frontend_input": "BOOLEAN",
"input_filter": "NONE",
- "is_required": true,
+ "is_required": false,
"is_unique": true,
"label": "abc123",
"multiline_count": 987,
@@ -41853,16 +42347,16 @@ Example
"custom_attributes": [AttributeValueInput],
"date_of_birth": "abc123",
"dob": "xyz789",
- "email": "abc123",
+ "email": "xyz789",
"firstname": "xyz789",
"gender": 987,
"is_subscribed": true,
"lastname": "abc123",
- "middlename": "xyz789",
- "password": "abc123",
- "prefix": "xyz789",
- "suffix": "abc123",
- "taxvat": "abc123"
+ "middlename": "abc123",
+ "password": "xyz789",
+ "prefix": "abc123",
+ "suffix": "xyz789",
+ "taxvat": "xyz789"
}
@@ -41924,9 +42418,9 @@ Fields
Example
{
- "date": "xyz789",
- "download_url": "abc123",
- "order_increment_id": "abc123",
+ "date": "abc123",
+ "download_url": "xyz789",
+ "order_increment_id": "xyz789",
"remaining_downloads": "abc123",
"status": "xyz789"
}
@@ -41976,11 +42470,11 @@ Example
back to top
-
+
- CustomerGroup
+ CustomerGroupStorefront
@@ -41998,9 +42492,9 @@ Fields
- name - String
+ uid - ID!
- The name of customer group.
+ The unique ID for a CustomerGroup object.
@@ -42009,7 +42503,7 @@ Fields
Example
- {"name": "abc123"}
+ {"uid": 4}
@@ -42119,17 +42613,17 @@ Fields
Example
{
"date_of_birth": "xyz789",
- "dob": "abc123",
- "email": "abc123",
- "firstname": "abc123",
+ "dob": "xyz789",
+ "email": "xyz789",
+ "firstname": "xyz789",
"gender": 123,
- "is_subscribed": false,
- "lastname": "abc123",
+ "is_subscribed": true,
+ "lastname": "xyz789",
"middlename": "xyz789",
"password": "abc123",
- "prefix": "abc123",
+ "prefix": "xyz789",
"suffix": "abc123",
- "taxvat": "xyz789"
+ "taxvat": "abc123"
}
@@ -42364,7 +42858,7 @@ Example
"applied_gift_cards": [ApplyGiftCardToOrder],
"available_actions": ["REORDER"],
"billing_address": OrderAddress,
- "carrier": "abc123",
+ "carrier": "xyz789",
"comments": [SalesCommentItem],
"created_at": "abc123",
"credit_memos": [CreditMemo],
@@ -42373,25 +42867,25 @@ Example
"gift_message": GiftMessage,
"gift_receipt_included": false,
"gift_wrapping": GiftWrapping,
- "grand_total": 987.65,
+ "grand_total": 123.45,
"id": "4",
- "increment_id": "xyz789",
+ "increment_id": "abc123",
"invoices": [Invoice],
- "is_virtual": false,
+ "is_virtual": true,
"items": [OrderItemInterface],
"items_eligible_for_return": [OrderItemInterface],
"number": "xyz789",
"order_date": "xyz789",
- "order_number": "abc123",
+ "order_number": "xyz789",
"order_status_change_date": "xyz789",
"payment_methods": [OrderPaymentMethod],
"printed_card_included": false,
"returns": Returns,
"shipments": [OrderShipment],
"shipping_address": OrderAddress,
- "shipping_method": "xyz789",
+ "shipping_method": "abc123",
"status": "abc123",
- "token": "abc123",
+ "token": "xyz789",
"total": OrderTotal
}
@@ -42546,7 +43040,7 @@ Example
"date_of_first_order": "xyz789",
"items": [CustomerOrder],
"page_info": SearchResultPageInfo,
- "total_count": 987
+ "total_count": 123
}
@@ -42698,16 +43192,16 @@ Example
back to top
-
+
- CustomerSegment
+ CustomerSegmentStorefront
Description
- Customer segment.
+ Customer segment details
Fields
@@ -42720,76 +43214,9 @@ Fields
- apply_to - CustomerSegmentApplyTo!
-
- Customer segment is applicable to visitor, registered customer or both.
-
-
- description - String
-
- Customer segment description.
-
-
- name - String!
-
- Customer segment name.
-
-
-
-
-
-
-
- Example
- {
- "apply_to": "BOTH",
- "description": "abc123",
- "name": "xyz789"
-}
-
-
-
- back to top
-
-
-
-
- Types
-
- CustomerSegmentApplyTo
-
-
-
- Description
- Customer segment is applicable to visitor, registered customers or both.
-
-
- Values
-
-
-
- Enum Value
- Description
-
-
-
-
-
- BOTH
-
- Customer segment is applicable to visitor and registered customers.
-
-
-
- REGISTERED
-
- Customer segment is applicable to registered customers.
-
-
-
- VISITOR
+ uid - ID!
- Customer segment is applicable to visitors/guests.
+ The unique ID for a CustomerSegment object.
@@ -42798,7 +43225,7 @@ Values
Example
- "BOTH"
+ {"uid": 4}
@@ -42924,7 +43351,7 @@ Example
{
"items": [CustomerStoreCreditHistoryItem],
"page_info": SearchResultPageInfo,
- "total_count": 123
+ "total_count": 987
}
@@ -42981,10 +43408,10 @@ Fields
Example
{
- "action": "xyz789",
+ "action": "abc123",
"actual_balance": Money,
"balance_change": Money,
- "date_time_changed": "abc123"
+ "date_time_changed": "xyz789"
}
@@ -43025,7 +43452,7 @@ Fields
Example
- {"token": "abc123"}
+ {"token": "xyz789"}
@@ -43134,16 +43561,16 @@ Fields
Example
{
- "allow_remote_shopping_assistance": true,
+ "allow_remote_shopping_assistance": false,
"custom_attributes": [AttributeValueInput],
"date_of_birth": "xyz789",
"dob": "xyz789",
- "firstname": "xyz789",
+ "firstname": "abc123",
"gender": 123,
- "is_subscribed": true,
+ "is_subscribed": false,
"lastname": "xyz789",
- "middlename": "abc123",
- "prefix": "xyz789",
+ "middlename": "xyz789",
+ "prefix": "abc123",
"suffix": "abc123",
"taxvat": "xyz789"
}
@@ -43218,12 +43645,12 @@ Fields
Example
{
- "option_id": 987,
- "product_sku": "xyz789",
+ "option_id": 123,
+ "product_sku": "abc123",
"required": false,
- "sort_order": 987,
- "title": "xyz789",
- "uid": "4",
+ "sort_order": 123,
+ "title": "abc123",
+ "uid": 4,
"value": CustomizableAreaValue
}
@@ -43286,8 +43713,8 @@ Fields
Example
{
- "max_characters": 123,
- "price": 123.45,
+ "max_characters": 987,
+ "price": 987.65,
"price_type": "FIXED",
"sku": "abc123",
"uid": 4
@@ -43361,8 +43788,8 @@ Example
"option_id": 123,
"required": true,
"sort_order": 987,
- "title": "abc123",
- "uid": "4",
+ "title": "xyz789",
+ "uid": 4,
"value": [CustomizableCheckboxValue]
}
@@ -43435,7 +43862,7 @@ Fields
Example
{
- "option_type_id": 123,
+ "option_type_id": 987,
"price": 123.45,
"price_type": "FIXED",
"sku": "xyz789",
@@ -43514,12 +43941,12 @@ Fields
Example
{
- "option_id": 123,
+ "option_id": 987,
"product_sku": "xyz789",
"required": true,
"sort_order": 123,
- "title": "abc123",
- "uid": "4",
+ "title": "xyz789",
+ "uid": 4,
"value": CustomizableDateValue
}
@@ -43638,7 +44065,7 @@ Fields
Example
{
- "price": 987.65,
+ "price": 123.45,
"price_type": "FIXED",
"sku": "abc123",
"type": "DATE",
@@ -43788,10 +44215,10 @@ Fields
Example
{
"option_type_id": 987,
- "price": 987.65,
+ "price": 123.45,
"price_type": "FIXED",
- "sku": "xyz789",
- "sort_order": 987,
+ "sku": "abc123",
+ "sort_order": 123,
"title": "xyz789",
"uid": 4
}
@@ -43867,8 +44294,8 @@ Fields
Example
{
"option_id": 123,
- "product_sku": "xyz789",
- "required": false,
+ "product_sku": "abc123",
+ "required": true,
"sort_order": 987,
"title": "xyz789",
"uid": 4,
@@ -43934,11 +44361,11 @@ Fields
Example
{
- "max_characters": 987,
+ "max_characters": 123,
"price": 123.45,
"price_type": "FIXED",
"sku": "abc123",
- "uid": 4
+ "uid": "4"
}
@@ -44011,12 +44438,12 @@ Fields
Example
{
- "option_id": 123,
- "product_sku": "xyz789",
- "required": false,
+ "option_id": 987,
+ "product_sku": "abc123",
+ "required": true,
"sort_order": 987,
- "title": "xyz789",
- "uid": "4",
+ "title": "abc123",
+ "uid": 4,
"value": CustomizableFileValue
}
@@ -44089,13 +44516,13 @@ Fields
Example
{
- "file_extension": "abc123",
- "image_size_x": 123,
- "image_size_y": 987,
+ "file_extension": "xyz789",
+ "image_size_x": 987,
+ "image_size_y": 123,
"price": 123.45,
"price_type": "FIXED",
- "sku": "abc123",
- "uid": "4"
+ "sku": "xyz789",
+ "uid": 4
}
@@ -44164,10 +44591,10 @@ Fields
Example
{
"option_id": 987,
- "required": false,
- "sort_order": 987,
+ "required": true,
+ "sort_order": 123,
"title": "abc123",
- "uid": 4,
+ "uid": "4",
"value": [CustomizableMultipleValue]
}
@@ -44240,12 +44667,12 @@ Fields
Example
{
- "option_type_id": 123,
+ "option_type_id": 987,
"price": 987.65,
"price_type": "FIXED",
- "sku": "abc123",
+ "sku": "xyz789",
"sort_order": 987,
- "title": "xyz789",
+ "title": "abc123",
"uid": 4
}
@@ -44301,9 +44728,9 @@ Fields
Example
{
- "id": 987,
- "uid": 4,
- "value_string": "abc123"
+ "id": 123,
+ "uid": "4",
+ "value_string": "xyz789"
}
@@ -44419,10 +44846,10 @@ Possible Types
Example
{
"option_id": 987,
- "required": true,
- "sort_order": 123,
+ "required": false,
+ "sort_order": 987,
"title": "abc123",
- "uid": 4
+ "uid": "4"
}
@@ -44485,12 +44912,12 @@ Possible Types
-
+
-
+
@@ -44572,11 +44999,11 @@ Fields
Example
{
- "option_id": 123,
- "required": true,
- "sort_order": 123,
- "title": "xyz789",
- "uid": 4,
+ "option_id": 987,
+ "required": false,
+ "sort_order": 987,
+ "title": "abc123",
+ "uid": "4",
"value": [CustomizableRadioValue]
}
@@ -44649,13 +45076,13 @@ Fields
Example
{
- "option_type_id": 123,
- "price": 123.45,
+ "option_type_id": 987,
+ "price": 987.65,
"price_type": "FIXED",
- "sku": "abc123",
- "sort_order": 123,
- "title": "abc123",
- "uid": "4"
+ "sku": "xyz789",
+ "sort_order": 987,
+ "title": "xyz789",
+ "uid": 4
}
@@ -44696,7 +45123,7 @@ Fields
Example
- {"success": false}
+ {"success": true}
@@ -44736,7 +45163,7 @@ Fields
Example
- {"success": true}
+ {"success": false}
@@ -44816,7 +45243,7 @@ Fields
Example
- {"result": false}
+ {"result": true}
@@ -45028,7 +45455,7 @@ Fields
Example
- {"quote_uids": [4]}
+ {"quote_uids": ["4"]}
@@ -45206,7 +45633,7 @@ Fields
Example
- {"message": "xyz789", "type": "UNDEFINED"}
+ {"message": "abc123", "type": "UNDEFINED"}
@@ -45292,7 +45719,7 @@ Fields
Example
- {"approval_rule_uids": ["4"]}
+ {"approval_rule_uids": [4]}
@@ -45417,7 +45844,7 @@ Fields
Example
- {"requisition_lists": RequisitionLists, "status": true}
+ {"requisition_lists": RequisitionLists, "status": false}
@@ -45536,8 +45963,8 @@ Example
"amount": Money,
"applied_to": "ITEM",
"coupon": AppliedCoupon,
- "is_discounting_locked": true,
- "label": "xyz789",
+ "is_discounting_locked": false,
+ "label": "abc123",
"type": "xyz789",
"value": 987.65
}
@@ -45661,19 +46088,19 @@ Example
"customizable_options": [SelectedCustomizableOption],
"discount": [Discount],
"errors": [CartItemError],
- "id": "xyz789",
- "is_available": false,
+ "id": "abc123",
+ "is_available": true,
"links": [DownloadableProductLinks],
- "max_qty": 987.65,
+ "max_qty": 123.45,
"min_qty": 987.65,
"not_available_message": "abc123",
"note_from_buyer": [ItemNote],
"note_from_seller": [ItemNote],
"prices": CartItemPrices,
"product": ProductInterface,
- "quantity": 987.65,
+ "quantity": 123.45,
"samples": [DownloadableProductSamples],
- "uid": "4"
+ "uid": 4
}
@@ -45752,12 +46179,12 @@ Example
{
"discounts": [Discount],
"downloadable_links": [DownloadableItemsLinks],
- "id": "4",
+ "id": 4,
"order_item": OrderItemInterface,
- "product_name": "xyz789",
+ "product_name": "abc123",
"product_sale_price": Money,
- "product_sku": "xyz789",
- "quantity_refunded": 123.45
+ "product_sku": "abc123",
+ "quantity_refunded": 987.65
}
@@ -45883,12 +46310,12 @@ Example
{
"discounts": [Discount],
"downloadable_links": [DownloadableItemsLinks],
- "id": 4,
+ "id": "4",
"order_item": OrderItemInterface,
- "product_name": "abc123",
+ "product_name": "xyz789",
"product_sale_price": Money,
- "product_sku": "abc123",
- "quantity_invoiced": 123.45
+ "product_sku": "xyz789",
+ "quantity_invoiced": 987.65
}
@@ -45940,7 +46367,7 @@ Fields
Example
{
- "sort_order": 987,
+ "sort_order": 123,
"title": "abc123",
"uid": "4"
}
@@ -46096,27 +46523,27 @@ Example
{
"discounts": [Discount],
"downloadable_links": [DownloadableItemsLinks],
- "eligible_for_return": false,
+ "eligible_for_return": true,
"entered_options": [OrderItemOption],
"gift_message": GiftMessage,
"gift_wrapping": GiftWrapping,
- "id": 4,
+ "id": "4",
"prices": OrderItemPrices,
"product": ProductInterface,
- "product_name": "xyz789",
+ "product_name": "abc123",
"product_sale_price": Money,
"product_sku": "xyz789",
- "product_type": "abc123",
- "product_url_key": "abc123",
+ "product_type": "xyz789",
+ "product_url_key": "xyz789",
"quantity_canceled": 123.45,
- "quantity_invoiced": 987.65,
- "quantity_ordered": 123.45,
+ "quantity_invoiced": 123.45,
+ "quantity_ordered": 987.65,
"quantity_refunded": 987.65,
"quantity_return_requested": 123.45,
"quantity_returned": 123.45,
- "quantity_shipped": 123.45,
+ "quantity_shipped": 987.65,
"selected_options": [OrderItemOption],
- "status": "xyz789"
+ "status": "abc123"
}
@@ -46145,13 +46572,6 @@ Fields
-
- activity - String
-
-
- Use the custom_attributes field instead.
-
-
attribute_set_id - Int
@@ -46168,27 +46588,6 @@ Fields
The categories assigned to a product.
-
- category_gear - String
-
-
- Use the custom_attributes field instead.
-
-
-
- climate - String
-
-
- Use the custom_attributes field instead.
-
-
-
- collar - String
-
-
- Use the custom_attributes field instead.
-
-
color - Int
@@ -46245,41 +46644,6 @@ filters
An array containing information about samples of this downloadable product.
-
- eco_collection - Int
-
-
- Use the custom_attributes field instead.
-
-
-
- erin_recommends - Int
-
-
- Use the custom_attributes field instead.
-
-
-
- features_bags - String
-
-
- Use the custom_attributes field instead.
-
-
-
- format - Int
-
-
- Use the custom_attributes field instead.
-
-
-
- gender - String
-
-
- Use the custom_attributes field instead.
-
-
gift_message_available - Boolean!
@@ -46327,13 +46691,6 @@ filters
A number representing the product's manufacturer. Use the custom_attributes field instead.
-
- material - String
-
-
- Use the custom_attributes field instead.
-
-
max_sale_qty - Float
@@ -46375,13 +46732,6 @@ filters
The product name. Customers use this name to identify the product.
-
- new - Int
-
-
- Use the custom_attributes field instead.
-
-
new_from_date - String
@@ -46407,20 +46757,6 @@ filters
If the product has multiple options, determines where they appear on the product page.
-
- pattern - String
-
-
- Use the custom_attributes field instead.
-
-
-
- performance_fabric - Int
-
-
- Use the custom_attributes field instead.
-
-
price - ProductPrices
@@ -46442,13 +46778,6 @@ filters
An array of ProductLinks objects.
-
- purpose - Int
-
-
- Use the custom_attributes field instead.
-
-
quantity - Float
@@ -46503,42 +46832,16 @@ currentPage
-
- rules - [CatalogRule]
-
- Provides applied catalog rules in the current active cart
-
-
- sale - Int
-
-
- Use the custom_attributes field instead.
-
-
short_description - ComplexTextValue
A short description of the product. Its use depends on the theme.
-
- size - Int
-
-
- Use the custom_attributes field instead.
-
-
sku - String
A number or code assigned to a product to identify the product, options, price, and manufacturer.
-
- sleeve - String
-
-
- Use the custom_attributes field instead.
-
-
small_image - ProductImage
@@ -46570,34 +46873,6 @@ currentPage
Stock status of the product
-
- strap_bags - String
-
-
- Use the custom_attributes field instead.
-
-
-
- style_bags - String
-
-
- Use the custom_attributes field instead.
-
-
-
- style_bottom - String
-
-
- Use the custom_attributes field instead.
-
-
-
- style_general - String
-
-
- Use the custom_attributes field instead.
-
-
swatch_image - String
@@ -46683,16 +46958,12 @@ currentPage
Example
{
- "activity": "abc123",
- "attribute_set_id": 987,
+ "attribute_set_id": 123,
"canonical_url": "xyz789",
"categories": [CategoryInterface],
- "category_gear": "abc123",
- "climate": "abc123",
- "collar": "xyz789",
- "color": 123,
+ "color": 987,
"country_of_manufacture": "xyz789",
- "created_at": "xyz789",
+ "created_at": "abc123",
"crosssell_products": [ProductInterface],
"custom_attributesV2": ProductCustomAttributes,
"description": ComplexTextValue,
@@ -46702,76 +46973,58 @@ Example
"downloadable_product_samples": [
DownloadableProductSamples
],
- "eco_collection": 987,
- "erin_recommends": 123,
- "features_bags": "xyz789",
- "format": 123,
- "gender": "xyz789",
"gift_message_available": false,
- "gift_wrapping_available": true,
+ "gift_wrapping_available": false,
"gift_wrapping_price": Money,
"id": 123,
"image": ProductImage,
"is_returnable": "abc123",
"links_purchased_separately": 123,
- "links_title": "abc123",
+ "links_title": "xyz789",
"manufacturer": 987,
- "material": "xyz789",
- "max_sale_qty": 123.45,
+ "max_sale_qty": 987.65,
"media_gallery": [MediaGalleryInterface],
"media_gallery_entries": [MediaGalleryEntry],
- "meta_description": "abc123",
+ "meta_description": "xyz789",
"meta_keyword": "xyz789",
- "meta_title": "abc123",
+ "meta_title": "xyz789",
"min_sale_qty": 987.65,
"name": "abc123",
- "new": 987,
"new_from_date": "abc123",
- "new_to_date": "xyz789",
+ "new_to_date": "abc123",
"only_x_left_in_stock": 123.45,
"options": [CustomizableOptionInterface],
"options_container": "xyz789",
- "pattern": "xyz789",
- "performance_fabric": 123,
"price": ProductPrices,
"price_range": PriceRange,
"price_tiers": [TierPrice],
"product_links": [ProductLinksInterface],
- "purpose": 987,
- "quantity": 987.65,
- "rating_summary": 987.65,
- "redirect_code": 123,
+ "quantity": 123.45,
+ "rating_summary": 123.45,
+ "redirect_code": 987,
"related_products": [ProductInterface],
"relative_url": "abc123",
- "review_count": 123,
+ "review_count": 987,
"reviews": ProductReviews,
- "rules": [CatalogRule],
- "sale": 123,
"short_description": ComplexTextValue,
- "size": 123,
"sku": "abc123",
- "sleeve": "abc123",
"small_image": ProductImage,
- "special_from_date": "xyz789",
- "special_price": 123.45,
+ "special_from_date": "abc123",
+ "special_price": 987.65,
"special_to_date": "xyz789",
- "staged": false,
+ "staged": true,
"stock_status": "IN_STOCK",
- "strap_bags": "abc123",
- "style_bags": "xyz789",
- "style_bottom": "abc123",
- "style_general": "abc123",
- "swatch_image": "xyz789",
+ "swatch_image": "abc123",
"thumbnail": ProductImage,
- "tier_price": 123.45,
+ "tier_price": 987.65,
"tier_prices": [ProductTierPrices],
"type": "CMS_PAGE",
"type_id": "abc123",
- "uid": 4,
- "updated_at": "abc123",
+ "uid": "4",
+ "updated_at": "xyz789",
"upsell_products": [ProductInterface],
"url_key": "abc123",
- "url_path": "abc123",
+ "url_path": "xyz789",
"url_rewrites": [UrlRewrite],
"url_suffix": "xyz789",
"websites": [Website]
@@ -46947,7 +47200,7 @@ Example
"sample_url": "abc123",
"sort_order": 987,
"title": "xyz789",
- "uid": 4
+ "uid": "4"
}
@@ -46989,7 +47242,7 @@ Fields
Example
- {"link_id": 987}
+ {"link_id": 123}
@@ -47061,12 +47314,12 @@ Fields
Example
{
- "id": 123,
- "sample_file": "abc123",
+ "id": 987,
+ "sample_file": "xyz789",
"sample_type": "FILE",
"sample_url": "abc123",
"sort_order": 987,
- "title": "abc123"
+ "title": "xyz789"
}
@@ -47138,7 +47391,7 @@ Example
"product": ProductInterface,
"quantity": 987.65,
"samples": [DownloadableProductSamples],
- "uid": "4"
+ "uid": 4
}
@@ -47215,10 +47468,10 @@ Fields
Example
{
- "added_at": "xyz789",
+ "added_at": "abc123",
"customizable_options": [SelectedCustomizableOption],
- "description": "xyz789",
- "id": 4,
+ "description": "abc123",
+ "id": "4",
"links_v2": [DownloadableProductLinks],
"product": ProductInterface,
"quantity": 123.45,
@@ -47271,7 +47524,7 @@ Fields
Example
{
- "duplicated_quote_uid": 4,
+ "duplicated_quote_uid": "4",
"quote_uid": "4"
}
@@ -47646,8 +47899,8 @@ Fields
Example
{
- "attribute_code": "xyz789",
- "value": "abc123"
+ "attribute_code": "abc123",
+ "value": "xyz789"
}
@@ -47695,7 +47948,10 @@ Fields
Example
- {"uid": 4, "value": "xyz789"}
+ {
+ "uid": "4",
+ "value": "xyz789"
+}
@@ -47764,11 +48020,11 @@ Fields
Example
{
- "canonical_url": "abc123",
- "entity_uid": 4,
- "id": 987,
- "redirectCode": 987,
- "relative_url": "abc123",
+ "canonical_url": "xyz789",
+ "entity_uid": "4",
+ "id": 123,
+ "redirectCode": 123,
+ "relative_url": "xyz789",
"type": "CMS_PAGE"
}
@@ -47839,7 +48095,7 @@ Possible Types
Example
{
"code": "PRODUCT_NOT_FOUND",
- "message": "xyz789"
+ "message": "abc123"
}
@@ -48054,6 +48310,95 @@ Fields
Example
{"cart": Cart}
+
+
+
+ back to top
+
+
+
+
+ Types
+
+ ExchangeExternalCustomerTokenInput
+
+
+
+ Description
+ Contains details about external customer.
+
+
+ Fields
+
+
+
+ Input Field
+ Description
+
+
+
+
+
+ customer - CustomerCreateInput!
+
+ An input object that defines the customer characteristics to update.
+
+
+
+
+
+
+
+ Example
+ {"customer": CustomerCreateInput}
+
+
+
+ back to top
+
+
+
+
+ Types
+
+ ExchangeExternalCustomerTokenOutput
+
+
+
+ Description
+ Contains customer token for external customer.
+
+
+
+
+
+ Example
+ {
+ "customer": Customer,
+ "token": "xyz789"
+}
@@ -48098,7 +48443,137 @@ Fields
Example
- {"currency_to": "xyz789", "rate": 123.45}
+ {"currency_to": "xyz789", "rate": 987.65}
+
+
+
+ back to top
+
+
+
+
+ Types
+
+ FastlaneConfig
+
+
+
+ Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+ code - String
+
+ The payment method code as defined in the payment gateway
+
+
+ is_visible - Boolean
+
+ Indicates whether the payment method is displayed
+
+
+ payment_intent - String
+
+ Defines the payment intent (Authorize or Capture
+
+
+ payment_source - String
+
+ The payment source for the payment method
+
+
+ sdk_params - [SDKParams]
+
+ The PayPal parameters required to load the JS SDK
+
+
+ sort_order - String
+
+ The relative order the payment method is displayed on the checkout page
+
+
+ three_ds_mode - ThreeDSMode
+
+ 3DS mode
+
+
+ title - String
+
+ The name displayed for the payment method
+
+
+
+
+
+
+
+ Example
+ {
+ "code": "abc123",
+ "is_visible": true,
+ "payment_intent": "abc123",
+ "payment_source": "abc123",
+ "sdk_params": [SDKParams],
+ "sort_order": "abc123",
+ "three_ds_mode": "OFF",
+ "title": "xyz789"
+}
+
+
+
+ back to top
+
+
+
+
+ Types
+
+ FastlaneMethodInput
+
+
+
+ Description
+ Fastlane Payment inputs
+
+
+
+
+
+ Example
+ {
+ "payment_source": "abc123",
+ "paypal_fastlane_token": "xyz789"
+}
@@ -48146,8 +48621,8 @@ Fields
Example
{
- "eq": "abc123",
- "in": ["xyz789"]
+ "eq": "xyz789",
+ "in": ["abc123"]
}
@@ -48346,7 +48821,7 @@ Example
{
"eq": "xyz789",
"in": ["xyz789"],
- "match": "abc123"
+ "match": "xyz789"
}
@@ -48474,21 +48949,21 @@ Fields
Example
{
- "eq": "abc123",
- "finset": ["abc123"],
+ "eq": "xyz789",
+ "finset": ["xyz789"],
"from": "xyz789",
"gt": "abc123",
"gteq": "abc123",
- "in": ["xyz789"],
- "like": "xyz789",
- "lt": "xyz789",
- "lteq": "xyz789",
- "moreq": "abc123",
- "neq": "abc123",
- "nin": ["abc123"],
+ "in": ["abc123"],
+ "like": "abc123",
+ "lt": "abc123",
+ "lteq": "abc123",
+ "moreq": "xyz789",
+ "neq": "xyz789",
+ "nin": ["xyz789"],
"notnull": "xyz789",
- "null": "xyz789",
- "to": "abc123"
+ "null": "abc123",
+ "to": "xyz789"
}
@@ -48536,7 +49011,7 @@ Fields
Example
{
"amount": Money,
- "label": "xyz789"
+ "label": "abc123"
}
@@ -48624,7 +49099,7 @@ Description
Example
- 123.45
+ 987.65
@@ -48665,7 +49140,7 @@ Fields
Example
- {"customer_email": "abc123"}
+ {"customer_email": "xyz789"}
@@ -48921,7 +49396,7 @@ Fields
Example
- {"gift_card_code": "xyz789"}
+ {"gift_card_code": "abc123"}
@@ -48989,11 +49464,11 @@ Fields
Example
{
"attribute_id": 123,
- "uid": "4",
- "value": 123.45,
- "value_id": 987,
+ "uid": 4,
+ "value": 987.65,
+ "value_id": 123,
"website_id": 123,
- "website_value": 123.45
+ "website_value": 987.65
}
@@ -49154,22 +49629,22 @@ Example
"errors": [CartItemError],
"gift_message": GiftMessage,
"gift_wrapping": GiftWrapping,
- "id": "abc123",
+ "id": "xyz789",
"is_available": false,
- "max_qty": 987.65,
+ "max_qty": 123.45,
"message": "xyz789",
- "min_qty": 987.65,
- "not_available_message": "xyz789",
+ "min_qty": 123.45,
+ "not_available_message": "abc123",
"note_from_buyer": [ItemNote],
"note_from_seller": [ItemNote],
"prices": CartItemPrices,
"product": ProductInterface,
"quantity": 123.45,
"recipient_email": "abc123",
- "recipient_name": "xyz789",
+ "recipient_name": "abc123",
"sender_email": "abc123",
- "sender_name": "xyz789",
- "uid": 4
+ "sender_name": "abc123",
+ "uid": "4"
}
@@ -49324,11 +49799,11 @@ Example
{
"discounts": [Discount],
"gift_card": GiftCardItem,
- "id": 4,
+ "id": "4",
"order_item": OrderItemInterface,
"product_name": "abc123",
"product_sale_price": Money,
- "product_sku": "xyz789",
+ "product_sku": "abc123",
"quantity_invoiced": 987.65
}
@@ -49391,8 +49866,8 @@ Fields
Example
{
- "message": "abc123",
- "recipient_email": "abc123",
+ "message": "xyz789",
+ "recipient_email": "xyz789",
"recipient_name": "abc123",
"sender_email": "xyz789",
"sender_name": "abc123"
@@ -49469,10 +49944,10 @@ Example
{
"amount": Money,
"custom_giftcard_amount": Money,
- "message": "abc123",
+ "message": "xyz789",
"recipient_email": "abc123",
"recipient_name": "abc123",
- "sender_email": "abc123",
+ "sender_email": "xyz789",
"sender_name": "xyz789"
}
@@ -49622,26 +50097,26 @@ Fields
Example
{
"discounts": [Discount],
- "eligible_for_return": false,
+ "eligible_for_return": true,
"entered_options": [OrderItemOption],
"gift_card": GiftCardItem,
"gift_message": GiftMessage,
"gift_wrapping": GiftWrapping,
- "id": "4",
+ "id": 4,
"prices": OrderItemPrices,
"product": ProductInterface,
- "product_name": "xyz789",
+ "product_name": "abc123",
"product_sale_price": Money,
- "product_sku": "xyz789",
- "product_type": "xyz789",
- "product_url_key": "xyz789",
- "quantity_canceled": 987.65,
- "quantity_invoiced": 987.65,
+ "product_sku": "abc123",
+ "product_type": "abc123",
+ "product_url_key": "abc123",
+ "quantity_canceled": 123.45,
+ "quantity_invoiced": 123.45,
"quantity_ordered": 123.45,
"quantity_refunded": 987.65,
"quantity_return_requested": 123.45,
"quantity_returned": 123.45,
- "quantity_shipped": 123.45,
+ "quantity_shipped": 987.65,
"selected_options": [OrderItemOption],
"status": "abc123"
}
@@ -49672,13 +50147,6 @@ Fields
-
- activity - String
-
-
- Use the custom_attributes field instead.
-
-
allow_message - Boolean
@@ -49705,27 +50173,6 @@ Fields
The categories assigned to a product.
-
- category_gear - String
-
-
- Use the custom_attributes field instead.
-
-
-
- climate - String
-
-
- Use the custom_attributes field instead.
-
-
-
- collar - String
-
-
- Use the custom_attributes field instead.
-
-
color - Int
@@ -49772,41 +50219,6 @@ filters
Detailed information about the product. The value can include simple HTML tags.
-
- eco_collection - Int
-
-
- Use the custom_attributes field instead.
-
-
-
- erin_recommends - Int
-
-
- Use the custom_attributes field instead.
-
-
-
- features_bags - String
-
-
- Use the custom_attributes field instead.
-
-
-
- format - Int
-
-
- Use the custom_attributes field instead.
-
-
-
- gender - String
-
-
- Use the custom_attributes field instead.
-
-
gift_card_options - [CustomizableOptionInterface]!
@@ -49869,13 +50281,6 @@ filters
A number representing the product's manufacturer. Use the custom_attributes field instead.
-
- material - String
-
-
- Use the custom_attributes field instead.
-
-
max_sale_qty - Float
@@ -49922,13 +50327,6 @@ filters
The product name. Customers use this name to identify the product.
-
- new - Int
-
-
- Use the custom_attributes field instead.
-
-
new_from_date - String
@@ -49964,20 +50362,6 @@ filters
If the product has multiple options, determines where they appear on the product page.
-
- pattern - String
-
-
- Use the custom_attributes field instead.
-
-
-
- performance_fabric - Int
-
-
- Use the custom_attributes field instead.
-
-
price - ProductPrices
@@ -49999,13 +50383,6 @@ filters
An array of ProductLinks objects.
-
- purpose - Int
-
-
- Use the custom_attributes field instead.
-
-
quantity - Float
@@ -50060,42 +50437,16 @@ currentPage
-
- rules - [CatalogRule]
-
- Provides applied catalog rules in the current active cart
-
-
- sale - Int
-
-
- Use the custom_attributes field instead.
-
-
short_description - ComplexTextValue
A short description of the product. Its use depends on the theme.
-
- size - Int
-
-
- Use the custom_attributes field instead.
-
-
sku - String
A number or code assigned to a product to identify the product, options, price, and manufacturer.
-
- sleeve - String
-
-
- Use the custom_attributes field instead.
-
-
small_image - ProductImage
@@ -50127,34 +50478,6 @@ currentPage
Stock status of the product
-
- strap_bags - String
-
-
- Use the custom_attributes field instead.
-
-
-
- style_bags - String
-
-
- Use the custom_attributes field instead.
-
-
-
- style_bottom - String
-
-
- Use the custom_attributes field instead.
-
-
-
- style_general - String
-
-
- Use the custom_attributes field instead.
-
-
swatch_image - String
@@ -50245,101 +50568,79 @@ currentPage
Example
{
- "activity": "abc123",
- "allow_message": true,
+ "allow_message": false,
"allow_open_amount": true,
- "attribute_set_id": 123,
+ "attribute_set_id": 987,
"canonical_url": "abc123",
"categories": [CategoryInterface],
- "category_gear": "abc123",
- "climate": "xyz789",
- "collar": "abc123",
- "color": 123,
+ "color": 987,
"country_of_manufacture": "xyz789",
- "created_at": "abc123",
+ "created_at": "xyz789",
"crosssell_products": [ProductInterface],
"custom_attributesV2": ProductCustomAttributes,
"description": ComplexTextValue,
- "eco_collection": 123,
- "erin_recommends": 987,
- "features_bags": "abc123",
- "format": 123,
- "gender": "abc123",
"gift_card_options": [CustomizableOptionInterface],
"gift_message_available": false,
- "gift_wrapping_available": false,
+ "gift_wrapping_available": true,
"gift_wrapping_price": Money,
"giftcard_amounts": [GiftCardAmounts],
"giftcard_type": "VIRTUAL",
"id": 123,
"image": ProductImage,
- "is_redeemable": false,
+ "is_redeemable": true,
"is_returnable": "abc123",
"lifetime": 987,
"manufacturer": 987,
- "material": "xyz789",
"max_sale_qty": 987.65,
"media_gallery": [MediaGalleryInterface],
"media_gallery_entries": [MediaGalleryEntry],
- "message_max_length": 123,
- "meta_description": "xyz789",
- "meta_keyword": "xyz789",
+ "message_max_length": 987,
+ "meta_description": "abc123",
+ "meta_keyword": "abc123",
"meta_title": "xyz789",
"min_sale_qty": 987.65,
- "name": "xyz789",
- "new": 123,
+ "name": "abc123",
"new_from_date": "xyz789",
"new_to_date": "xyz789",
"only_x_left_in_stock": 123.45,
- "open_amount_max": 987.65,
- "open_amount_min": 123.45,
+ "open_amount_max": 123.45,
+ "open_amount_min": 987.65,
"options": [CustomizableOptionInterface],
"options_container": "abc123",
- "pattern": "xyz789",
- "performance_fabric": 987,
"price": ProductPrices,
"price_range": PriceRange,
"price_tiers": [TierPrice],
"product_links": [ProductLinksInterface],
- "purpose": 987,
- "quantity": 987.65,
+ "quantity": 123.45,
"rating_summary": 123.45,
- "redirect_code": 123,
+ "redirect_code": 987,
"related_products": [ProductInterface],
- "relative_url": "abc123",
- "review_count": 987,
+ "relative_url": "xyz789",
+ "review_count": 123,
"reviews": ProductReviews,
- "rules": [CatalogRule],
- "sale": 123,
"short_description": ComplexTextValue,
- "size": 123,
- "sku": "xyz789",
- "sleeve": "xyz789",
+ "sku": "abc123",
"small_image": ProductImage,
"special_from_date": "abc123",
"special_price": 987.65,
- "special_to_date": "xyz789",
- "staged": true,
+ "special_to_date": "abc123",
+ "staged": false,
"stock_status": "IN_STOCK",
- "strap_bags": "abc123",
- "style_bags": "xyz789",
- "style_bottom": "abc123",
- "style_general": "abc123",
- "swatch_image": "abc123",
+ "swatch_image": "xyz789",
"thumbnail": ProductImage,
"tier_price": 987.65,
"tier_prices": [ProductTierPrices],
"type": "CMS_PAGE",
- "type_id": "abc123",
- "uid": "4",
+ "type_id": "xyz789",
+ "uid": 4,
"updated_at": "abc123",
"upsell_products": [ProductInterface],
"url_key": "abc123",
"url_path": "xyz789",
"url_rewrites": [UrlRewrite],
- "url_suffix": "xyz789",
+ "url_suffix": "abc123",
"websites": [Website],
- "weight": 987.65
+ "weight": 123.45
}
@@ -50404,8 +50705,8 @@ Example
"customizable_options": [SelectedCustomizableOption],
"gift_card_options": GiftCardOptions,
"product": ProductInterface,
- "quantity": 123.45,
- "uid": "4"
+ "quantity": 987.65,
+ "uid": 4
}
@@ -50474,9 +50775,9 @@ Fields
Example
{
"gift_card": GiftCardItem,
- "id": 4,
+ "id": "4",
"order_item": OrderItemInterface,
- "product_name": "xyz789",
+ "product_name": "abc123",
"product_sale_price": Money,
"product_sku": "xyz789",
"quantity_shipped": 987.65
@@ -50607,14 +50908,59 @@ Fields
Example
{
- "added_at": "abc123",
+ "added_at": "xyz789",
"customizable_options": [SelectedCustomizableOption],
- "description": "xyz789",
+ "description": "abc123",
"gift_card_options": GiftCardOptions,
"id": "4",
"product": ProductInterface,
- "quantity": 123.45
+ "quantity": 987.65
}
+
+
+
+ back to top
+
+
+
+
+ Types
+
+ GiftCartAttributeValue
+
+
+
+ Description
+ Gift card custom attribute value containing array data.
+
+
+
+
+
+ Example
+ {"code": 4, "options": ["xyz789"]}
@@ -50665,9 +51011,9 @@ Fields
Example
{
- "from": "xyz789",
+ "from": "abc123",
"message": "xyz789",
- "to": "xyz789"
+ "to": "abc123"
}
@@ -50723,7 +51069,7 @@ Fields
Example
{
"from": "abc123",
- "message": "xyz789",
+ "message": "abc123",
"to": "abc123"
}
@@ -50893,12 +51239,12 @@ Fields
Example
{
- "created_at": "abc123",
+ "created_at": "xyz789",
"dynamic_attributes": [GiftRegistryDynamicAttribute],
"event_name": "abc123",
"items": [GiftRegistryItemInterface],
- "message": "xyz789",
- "owner_name": "xyz789",
+ "message": "abc123",
+ "owner_name": "abc123",
"privacy_settings": "PRIVATE",
"registrants": [GiftRegistryRegistrant],
"shipping_address": CustomerAddress,
@@ -50959,8 +51305,8 @@ Example
{
"code": "4",
"group": "EVENT_INFORMATION",
- "label": "abc123",
- "value": "xyz789"
+ "label": "xyz789",
+ "value": "abc123"
}
@@ -51085,7 +51431,10 @@ Fields
Example
- {"code": 4, "value": "abc123"}
+ {
+ "code": "4",
+ "value": "xyz789"
+}
@@ -51154,7 +51503,7 @@ Possible Types
Example
{
- "code": 4,
+ "code": "4",
"label": "xyz789",
"value": "abc123"
}
@@ -51223,7 +51572,7 @@ Example
"code": 4,
"input_type": "abc123",
"is_required": false,
- "label": "abc123",
+ "label": "xyz789",
"sort_order": 987
}
@@ -51304,12 +51653,12 @@ Possible Types
Example
{
- "attribute_group": "abc123",
- "code": 4,
- "input_type": "xyz789",
+ "attribute_group": "xyz789",
+ "code": "4",
+ "input_type": "abc123",
"is_required": false,
"label": "abc123",
- "sort_order": 987
+ "sort_order": 123
}
@@ -51376,8 +51725,8 @@ Example
"note": "xyz789",
"product": ProductInterface,
"quantity": 987.65,
- "quantity_fulfilled": 987.65,
- "uid": "4"
+ "quantity_fulfilled": 123.45,
+ "uid": 4
}
@@ -51460,9 +51809,9 @@ Example
"created_at": "abc123",
"note": "xyz789",
"product": ProductInterface,
- "quantity": 123.45,
- "quantity_fulfilled": 123.45,
- "uid": 4
+ "quantity": 987.65,
+ "quantity_fulfilled": 987.65,
+ "uid": "4"
}
@@ -51526,7 +51875,7 @@ Possible Types
Example
{
- "status": false,
+ "status": true,
"user_errors": [GiftRegistryItemsUserError]
}
@@ -51592,7 +51941,7 @@ Example
"code": "OUT_OF_STOCK",
"gift_registry_item_uid": "4",
"gift_registry_uid": "4",
- "message": "abc123",
+ "message": "xyz789",
"product_uid": 4
}
@@ -51817,9 +52166,9 @@ Example
"dynamic_attributes": [
GiftRegistryRegistrantDynamicAttribute
],
- "email": "abc123",
+ "email": "xyz789",
"firstname": "xyz789",
- "lastname": "abc123",
+ "lastname": "xyz789",
"uid": 4
}
@@ -51870,7 +52219,7 @@ Example
{
"code": "4",
"label": "abc123",
- "value": "abc123"
+ "value": "xyz789"
}
@@ -51940,9 +52289,9 @@ Example
"event_date": "xyz789",
"event_title": "abc123",
"gift_registry_uid": "4",
- "location": "abc123",
- "name": "xyz789",
- "type": "xyz789"
+ "location": "xyz789",
+ "name": "abc123",
+ "type": "abc123"
}
@@ -51983,6 +52332,12 @@ Fields
The ID assigned to this customer address.
+
+
+ customer_address_uid - ID
+
+ The unique ID assigned to this customer address.
+
@@ -51990,7 +52345,11 @@ Fields
Example
- {"address_data": CustomerAddressInput, "address_id": 4}
+ {
+ "address_data": CustomerAddressInput,
+ "address_id": "4",
+ "customer_address_uid": "4"
+}
@@ -52093,8 +52452,8 @@ Example
"dynamic_attributes_metadata": [
GiftRegistryDynamicAttributeMetadataInterface
],
- "label": "xyz789",
- "uid": "4"
+ "label": "abc123",
+ "uid": 4
}
@@ -52161,7 +52520,7 @@ Example
"id": 4,
"image": GiftWrappingImage,
"price": Money,
- "uid": "4"
+ "uid": 4
}
@@ -52208,7 +52567,7 @@ Fields
Example
{
- "label": "xyz789",
+ "label": "abc123",
"url": "xyz789"
}
@@ -52258,7 +52617,7 @@ Fields
Example
{
"color": "xyz789",
- "height": 123,
+ "height": 987,
"type": "xyz789"
}
@@ -52338,14 +52697,14 @@ Fields
Example
{
"button_styles": GooglePayButtonStyles,
- "code": "abc123",
- "is_visible": true,
- "payment_intent": "xyz789",
+ "code": "xyz789",
+ "is_visible": false,
+ "payment_intent": "abc123",
"payment_source": "abc123",
"sdk_params": [SDKParams],
"sort_order": "xyz789",
"three_ds_mode": "OFF",
- "title": "xyz789"
+ "title": "abc123"
}
@@ -52401,7 +52760,7 @@ Fields
Example
{
"payment_source": "xyz789",
- "payments_order_id": "abc123",
+ "payments_order_id": "xyz789",
"paypal_order_id": "abc123"
}
@@ -52431,13 +52790,6 @@ Fields
-
- activity - String
-
-
- Use the custom_attributes field instead.
-
-
attribute_set_id - Int
@@ -52454,27 +52806,6 @@ Fields
The categories assigned to a product.
-
- category_gear - String
-
-
- Use the custom_attributes field instead.
-
-
-
- climate - String
-
-
- Use the custom_attributes field instead.
-
-
-
- collar - String
-
-
- Use the custom_attributes field instead.
-
-
color - Int
@@ -52521,41 +52852,6 @@ filters
Detailed information about the product. The value can include simple HTML tags.
-
- eco_collection - Int
-
-
- Use the custom_attributes field instead.
-
-
-
- erin_recommends - Int
-
-
- Use the custom_attributes field instead.
-
-
-
- features_bags - String
-
-
- Use the custom_attributes field instead.
-
-
-
- format - Int
-
-
- Use the custom_attributes field instead.
-
-
-
- gender - String
-
-
- Use the custom_attributes field instead.
-
-
gift_message_available - Boolean!
@@ -52598,13 +52894,6 @@ filters
A number representing the product's manufacturer. Use the custom_attributes field instead.
-
- material - String
-
-
- Use the custom_attributes field instead.
-
-
max_sale_qty - Float
@@ -52646,13 +52935,6 @@ filters
The product name. Customers use this name to identify the product.
-
- new - Int
-
-
- Use the custom_attributes field instead.
-
-
new_from_date - String
@@ -52673,20 +52955,6 @@ filters
If the product has multiple options, determines where they appear on the product page.
-
- pattern - String
-
-
- Use the custom_attributes field instead.
-
-
-
- performance_fabric - Int
-
-
- Use the custom_attributes field instead.
-
-
price - ProductPrices
@@ -52708,13 +52976,6 @@ filters
An array of ProductLinks objects.
-
- purpose - Int
-
-
- Use the custom_attributes field instead.
-
-
quantity - Float
@@ -52769,42 +53030,16 @@ currentPage
-
- rules - [CatalogRule]
-
- Provides applied catalog rules in the current active cart
-
-
- sale - Int
-
-
- Use the custom_attributes field instead.
-
-
short_description - ComplexTextValue
A short description of the product. Its use depends on the theme.
-
- size - Int
-
-
- Use the custom_attributes field instead.
-
-
sku - String
A number or code assigned to a product to identify the product, options, price, and manufacturer.
-
- sleeve - String
-
-
- Use the custom_attributes field instead.
-
-
small_image - ProductImage
@@ -52836,34 +53071,6 @@ currentPage
Stock status of the product
-
- strap_bags - String
-
-
- Use the custom_attributes field instead.
-
-
-
- style_bags - String
-
-
- Use the custom_attributes field instead.
-
-
-
- style_bottom - String
-
-
- Use the custom_attributes field instead.
-
-
-
- style_general - String
-
-
- Use the custom_attributes field instead.
-
-
swatch_image - String
@@ -52954,33 +53161,23 @@ currentPage
Example
{
- "activity": "xyz789",
- "attribute_set_id": 987,
+ "attribute_set_id": 123,
"canonical_url": "abc123",
"categories": [CategoryInterface],
- "category_gear": "abc123",
- "climate": "abc123",
- "collar": "abc123",
"color": 987,
"country_of_manufacture": "xyz789",
- "created_at": "xyz789",
+ "created_at": "abc123",
"crosssell_products": [ProductInterface],
"custom_attributesV2": ProductCustomAttributes,
"description": ComplexTextValue,
- "eco_collection": 987,
- "erin_recommends": 123,
- "features_bags": "xyz789",
- "format": 987,
- "gender": "xyz789",
"gift_message_available": false,
- "gift_wrapping_available": false,
+ "gift_wrapping_available": true,
"gift_wrapping_price": Money,
- "id": 987,
+ "id": 123,
"image": ProductImage,
"is_returnable": "abc123",
"items": [GroupedProductItem],
- "manufacturer": 987,
- "material": "xyz789",
+ "manufacturer": 123,
"max_sale_qty": 123.45,
"media_gallery": [MediaGalleryInterface],
"media_gallery_entries": [MediaGalleryEntry],
@@ -52988,19 +53185,15 @@ Example
"meta_keyword": "xyz789",
"meta_title": "xyz789",
"min_sale_qty": 987.65,
- "name": "xyz789",
- "new": 123,
+ "name": "abc123",
"new_from_date": "xyz789",
- "new_to_date": "abc123",
+ "new_to_date": "xyz789",
"only_x_left_in_stock": 987.65,
"options_container": "xyz789",
- "pattern": "xyz789",
- "performance_fabric": 987,
"price": ProductPrices,
"price_range": PriceRange,
"price_tiers": [TierPrice],
"product_links": [ProductLinksInterface],
- "purpose": 987,
"quantity": 987.65,
"rating_summary": 123.45,
"redirect_code": 123,
@@ -53008,37 +53201,29 @@ Example
"relative_url": "xyz789",
"review_count": 123,
"reviews": ProductReviews,
- "rules": [CatalogRule],
- "sale": 123,
"short_description": ComplexTextValue,
- "size": 987,
- "sku": "abc123",
- "sleeve": "abc123",
+ "sku": "xyz789",
"small_image": ProductImage,
- "special_from_date": "xyz789",
+ "special_from_date": "abc123",
"special_price": 987.65,
"special_to_date": "abc123",
- "staged": true,
+ "staged": false,
"stock_status": "IN_STOCK",
- "strap_bags": "xyz789",
- "style_bags": "abc123",
- "style_bottom": "xyz789",
- "style_general": "abc123",
- "swatch_image": "xyz789",
+ "swatch_image": "abc123",
"thumbnail": ProductImage,
- "tier_price": 987.65,
+ "tier_price": 123.45,
"tier_prices": [ProductTierPrices],
"type": "CMS_PAGE",
"type_id": "xyz789",
"uid": "4",
- "updated_at": "abc123",
+ "updated_at": "xyz789",
"upsell_products": [ProductInterface],
"url_key": "xyz789",
"url_path": "abc123",
"url_rewrites": [UrlRewrite],
- "url_suffix": "abc123",
+ "url_suffix": "xyz789",
"websites": [Website],
- "weight": 123.45
+ "weight": 987.65
}
@@ -53159,12 +53344,12 @@ Fields
Example
{
- "added_at": "xyz789",
+ "added_at": "abc123",
"customizable_options": [SelectedCustomizableOption],
"description": "xyz789",
- "id": "4",
+ "id": 4,
"product": ProductInterface,
- "quantity": 987.65
+ "quantity": 123.45
}
@@ -53214,7 +53399,64 @@ Fields
Example
{
"reason": "xyz789",
- "token": "xyz789"
+ "token": "abc123"
+}
+
+
+
+ back to top
+
+
+
+
+ Types
+
+ GuestOrderInformationInput
+
+
+
+ Description
+ Input to retrieve an order based on details.
+
+
+
+
+
+ Example
+ {
+ "email": "xyz789",
+ "lastname": "xyz789",
+ "number": "xyz789"
}
@@ -53308,18 +53550,18 @@ Fields
Example
{
- "cc_vault_code": "xyz789",
+ "cc_vault_code": "abc123",
"code": "abc123",
"is_vault_enabled": false,
- "is_visible": true,
- "payment_intent": "abc123",
+ "is_visible": false,
+ "payment_intent": "xyz789",
"payment_source": "abc123",
- "requires_card_details": false,
+ "requires_card_details": true,
"sdk_params": [SDKParams],
- "sort_order": "abc123",
- "three_ds": false,
+ "sort_order": "xyz789",
+ "three_ds": true,
"three_ds_mode": "OFF",
- "title": "abc123"
+ "title": "xyz789"
}
@@ -53410,15 +53652,15 @@ Fields
Example
{
- "cardBin": "abc123",
+ "cardBin": "xyz789",
"cardExpiryMonth": "abc123",
"cardExpiryYear": "abc123",
- "cardLast4": "abc123",
- "holderName": "abc123",
- "is_active_payment_token_enabler": false,
+ "cardLast4": "xyz789",
+ "holderName": "xyz789",
+ "is_active_payment_token_enabler": true,
"payment_source": "xyz789",
"payments_order_id": "abc123",
- "paypal_order_id": "abc123"
+ "paypal_order_id": "xyz789"
}
@@ -53467,7 +53709,7 @@ Fields
Example
{
- "cancel_url": "xyz789",
+ "cancel_url": "abc123",
"return_url": "xyz789"
}
@@ -53550,7 +53792,7 @@ Fields
Example
- {"cart_id": "abc123"}
+ {"cart_id": "xyz789"}
@@ -53596,8 +53838,8 @@ Fields
Example
{
- "name": "abc123",
- "value": "xyz789"
+ "name": "xyz789",
+ "value": "abc123"
}
@@ -53620,7 +53862,7 @@ Description
Example
- "4"
+ 4
@@ -53777,8 +54019,8 @@ Fields
Example
{
"code": "PRODUCT_NOT_FOUND",
- "message": "abc123",
- "quantity": 987.65
+ "message": "xyz789",
+ "quantity": 123.45
}
@@ -53903,9 +54145,9 @@ Fields
Example
{
"comments": [SalesCommentItem],
- "id": 4,
+ "id": "4",
"items": [InvoiceItemInterface],
- "number": "abc123",
+ "number": "xyz789",
"total": InvoiceTotal
}
@@ -53975,11 +54217,11 @@ Fields
Example
{
"discounts": [Discount],
- "id": "4",
+ "id": 4,
"order_item": OrderItemInterface,
"product_name": "abc123",
"product_sale_price": Money,
- "product_sku": "abc123",
+ "product_sku": "xyz789",
"quantity_invoiced": 123.45
}
@@ -54058,12 +54300,12 @@ Possible Types
-
+
-
+
@@ -54087,9 +54329,9 @@ Example
"discounts": [Discount],
"id": 4,
"order_item": OrderItemInterface,
- "product_name": "abc123",
+ "product_name": "xyz789",
"product_sale_price": Money,
- "product_sku": "xyz789",
+ "product_sku": "abc123",
"quantity_invoiced": 987.65
}
@@ -54215,7 +54457,7 @@ Fields
Example
- {"is_email_available": true}
+ {"is_email_available": false}
@@ -54295,7 +54537,7 @@ Fields
Example
- {"is_role_name_available": true}
+ {"is_role_name_available": false}
@@ -54441,9 +54683,9 @@ Fields
Example
{
- "created_at": "abc123",
+ "created_at": "xyz789",
"creator_id": 987,
- "creator_type": 987,
+ "creator_type": 123,
"negotiable_quote_item_uid": "4",
"note": "abc123",
"note_uid": "4"
@@ -54505,7 +54747,7 @@ Fields
Example
{
"id": 4,
- "label": "xyz789",
+ "label": "abc123",
"uid": 4,
"values": [ItemSelectedBundleOptionValue]
}
@@ -54577,10 +54819,10 @@ Example
{
"id": "4",
"price": Money,
- "product_name": "abc123",
+ "product_name": "xyz789",
"product_sku": "abc123",
- "quantity": 123.45,
- "uid": "4"
+ "quantity": 987.65,
+ "uid": 4
}
@@ -54745,7 +54987,7 @@ Example
{
"items_count": 123,
"label": "abc123",
- "value_string": "xyz789"
+ "value_string": "abc123"
}
@@ -54818,8 +55060,8 @@ Possible Types
Example
{
- "items_count": 987,
- "label": "abc123",
+ "items_count": 123,
+ "label": "xyz789",
"value_string": "xyz789"
}
@@ -54877,7 +55119,7 @@ Example
{
"note": "xyz789",
"quote_item_uid": 4,
- "quote_uid": "4"
+ "quote_uid": 4
}
@@ -54969,8 +55211,8 @@ Example
"disabled": false,
"file": "xyz789",
"id": 987,
- "label": "xyz789",
- "media_type": "abc123",
+ "label": "abc123",
+ "media_type": "xyz789",
"position": 123,
"types": ["abc123"],
"uid": 4,
@@ -55018,6 +55260,11 @@ Fields
The media item's position after it has been sorted.
+
+ types - [String]
+
+ Array of image types. It can have the following values: image, small_image, thumbnail.
+
url - String
@@ -55053,9 +55300,10 @@ Possible Types
Example
{
- "disabled": true,
+ "disabled": false,
"label": "abc123",
- "position": 123,
+ "position": 987,
+ "types": ["abc123"],
"url": "abc123"
}
@@ -55093,7 +55341,7 @@ Fields
Example
- {"type": "abc123"}
+ {"type": "xyz789"}
@@ -55182,7 +55430,7 @@ Fields
Example
- {"currency": "AFN", "value": 987.65}
+ {"currency": "AFN", "value": 123.45}
@@ -55234,7 +55482,7 @@ Fields
Example
{
"gift_registry": GiftRegistry,
- "status": true,
+ "status": false,
"user_errors": [GiftRegistryItemsUserError]
}
@@ -55378,7 +55626,11 @@ Fields
Example
- {"quote_item_uid": 4, "quote_uid": 4, "requisition_list_uid": 4}
+ {
+ "quote_item_uid": "4",
+ "quote_uid": 4,
+ "requisition_list_uid": "4"
+}
@@ -55597,18 +55849,18 @@ Example
"billing_address": NegotiableQuoteBillingAddress,
"buyer": NegotiableQuoteUser,
"comments": [NegotiableQuoteComment],
- "created_at": "xyz789",
- "email": "xyz789",
+ "created_at": "abc123",
+ "email": "abc123",
"history": [NegotiableQuoteHistoryEntry],
- "is_virtual": true,
+ "is_virtual": false,
"items": [CartItemInterface],
- "name": "xyz789",
+ "name": "abc123",
"prices": CartPrices,
"selected_payment_method": SelectedPaymentMethod,
"shipping_addresses": [NegotiableQuoteShippingAddress],
"status": "SUBMITTED",
"total_quantity": 987.65,
- "uid": "4",
+ "uid": 4,
"updated_at": "abc123"
}
@@ -55760,17 +56012,17 @@ Fields
Example
{
- "city": "abc123",
- "company": "xyz789",
+ "city": "xyz789",
+ "company": "abc123",
"country_code": "abc123",
- "firstname": "abc123",
- "lastname": "abc123",
- "postcode": "abc123",
- "region": "abc123",
- "region_id": 123,
- "save_in_address_book": true,
- "street": ["abc123"],
- "telephone": "xyz789"
+ "firstname": "xyz789",
+ "lastname": "xyz789",
+ "postcode": "xyz789",
+ "region": "xyz789",
+ "region_id": 987,
+ "save_in_address_book": false,
+ "street": ["xyz789"],
+ "telephone": "abc123"
}
@@ -55871,9 +56123,9 @@ Possible Types
Example
{
"city": "abc123",
- "company": "xyz789",
+ "company": "abc123",
"country": NegotiableQuoteAddressCountry,
- "firstname": "xyz789",
+ "firstname": "abc123",
"lastname": "abc123",
"postcode": "xyz789",
"region": NegotiableQuoteAddressRegion,
@@ -55931,8 +56183,8 @@ Fields
Example
{
"code": "abc123",
- "label": "abc123",
- "region_id": 123
+ "label": "xyz789",
+ "region_id": 987
}
@@ -56010,14 +56262,14 @@ Fields
Example
{
- "city": "abc123",
+ "city": "xyz789",
"company": "xyz789",
"country": NegotiableQuoteAddressCountry,
- "firstname": "xyz789",
+ "firstname": "abc123",
"lastname": "xyz789",
- "postcode": "xyz789",
+ "postcode": "abc123",
"region": NegotiableQuoteAddressRegion,
- "street": ["xyz789"],
+ "street": ["abc123"],
"telephone": "xyz789"
}
@@ -56081,7 +56333,7 @@ Example
{
"address": NegotiableQuoteAddressInput,
"customer_address_uid": 4,
- "same_as_shipping": true,
+ "same_as_shipping": false,
"use_for_shipping": false
}
@@ -56148,7 +56400,7 @@ Example
"created_at": "xyz789",
"creator_type": "BUYER",
"text": "abc123",
- "uid": 4
+ "uid": "4"
}
@@ -56235,7 +56487,7 @@ Fields
Example
- {"comment": "xyz789"}
+ {"comment": "abc123"}
@@ -56287,7 +56539,7 @@ Fields
Example
{
"new_value": "xyz789",
- "old_value": "xyz789",
+ "old_value": "abc123",
"title": "abc123"
}
@@ -56515,7 +56767,7 @@ Example
"author": NegotiableQuoteUser,
"change_type": "CREATED",
"changes": NegotiableQuoteHistoryChanges,
- "created_at": "xyz789",
+ "created_at": "abc123",
"uid": "4"
}
@@ -56623,7 +56875,7 @@ Fields
Example
{
"new_expiration": "abc123",
- "old_expiration": "xyz789"
+ "old_expiration": "abc123"
}
@@ -56892,7 +57144,7 @@ Fields
Example
- {"quantity": 987.65, "quote_item_uid": 4}
+ {"quantity": 123.45, "quote_item_uid": "4"}
@@ -56999,9 +57251,9 @@ Fields
Example
{
"document_identifier": "xyz789",
- "document_name": "abc123",
+ "document_name": "xyz789",
"link_id": 4,
- "reference_document_url": "xyz789"
+ "reference_document_url": "abc123"
}
@@ -57091,7 +57343,7 @@ Example
{
"available_shipping_methods": [AvailableShippingMethod],
"city": "abc123",
- "company": "abc123",
+ "company": "xyz789",
"country": NegotiableQuoteAddressCountry,
"firstname": "abc123",
"lastname": "xyz789",
@@ -57099,7 +57351,7 @@ Example
"region": NegotiableQuoteAddressRegion,
"selected_shipping_method": SelectedShippingMethod,
"street": ["abc123"],
- "telephone": "xyz789"
+ "telephone": "abc123"
}
@@ -57470,14 +57722,14 @@ Example
{
"buyer": NegotiableQuoteUser,
"comments": [NegotiableQuoteComment],
- "expiration_date": "abc123",
+ "expiration_date": "xyz789",
"history": [NegotiableQuoteHistoryEntry],
- "is_min_max_qty_used": false,
+ "is_min_max_qty_used": true,
"is_virtual": true,
"items": [CartItemInterface],
"max_order_commitment": 987,
"min_order_commitment": 123,
- "name": "xyz789",
+ "name": "abc123",
"notifications": [QuoteTemplateNotificationMessage],
"prices": CartPrices,
"reference_document_links": [
@@ -57485,8 +57737,8 @@ Example
],
"shipping_addresses": [NegotiableQuoteShippingAddress],
"status": "xyz789",
- "template_id": "4",
- "total_quantity": 987.65
+ "template_id": 4,
+ "total_quantity": 123.45
}
@@ -57648,21 +57900,21 @@ Fields
Example
{
- "activated_at": "abc123",
+ "activated_at": "xyz789",
"company_name": "abc123",
"expiration_date": "abc123",
"is_min_max_qty_used": true,
- "last_shared_at": "xyz789",
- "max_order_commitment": 123,
- "min_negotiated_grand_total": 123.45,
- "min_order_commitment": 123,
- "name": "xyz789",
- "orders_placed": 987,
- "sales_rep_name": "xyz789",
- "state": "xyz789",
- "status": "abc123",
- "submitted_by": "xyz789",
- "template_id": 4
+ "last_shared_at": "abc123",
+ "max_order_commitment": 987,
+ "min_negotiated_grand_total": 987.65,
+ "min_order_commitment": 987,
+ "name": "abc123",
+ "orders_placed": 123,
+ "sales_rep_name": "abc123",
+ "state": "abc123",
+ "status": "xyz789",
+ "submitted_by": "abc123",
+ "template_id": "4"
}
@@ -57722,12 +57974,7 @@ Fields
Example
- {
- "item_id": "4",
- "max_qty": 987.65,
- "min_qty": 987.65,
- "quantity": 987.65
-}
+ {"item_id": 4, "max_qty": 123.45, "min_qty": 123.45, "quantity": 123.45}
@@ -57788,8 +58035,8 @@ Fields
Example
{
"document_identifier": "abc123",
- "document_name": "abc123",
- "link_id": "4",
+ "document_name": "xyz789",
+ "link_id": 4,
"reference_document_url": "xyz789"
}
@@ -57846,8 +58093,8 @@ Fields
Example
{
"address": NegotiableQuoteAddressInput,
- "customer_address_uid": 4,
- "customer_notes": "abc123"
+ "customer_address_uid": "4",
+ "customer_notes": "xyz789"
}
@@ -57997,7 +58244,7 @@ Example
"items": [NegotiableQuoteTemplateGridItem],
"page_info": SearchResultPageInfo,
"sort_fields": SortFields,
- "total_count": 987
+ "total_count": 123
}
@@ -58051,7 +58298,7 @@ Possible Types
Example
- {"quote_uid": 4}
+ {"quote_uid": "4"}
@@ -58137,8 +58384,8 @@ Fields
Example
{
- "firstname": "xyz789",
- "lastname": "abc123"
+ "firstname": "abc123",
+ "lastname": "xyz789"
}
@@ -58198,7 +58445,7 @@ Example
"items": [NegotiableQuote],
"page_info": SearchResultPageInfo,
"sort_fields": SortFields,
- "total_count": 123
+ "total_count": 987
}
@@ -58245,7 +58492,7 @@ Fields
Example
{
- "message": "abc123",
+ "message": "xyz789",
"uid": "4"
}
@@ -58337,7 +58584,7 @@ Fields
Example
{
"order_id": "abc123",
- "order_number": "xyz789"
+ "order_number": "abc123"
}
@@ -58523,21 +58770,21 @@ attributeCodes
Example
{
- "city": "xyz789",
+ "city": "abc123",
"company": "abc123",
"country_code": "AF",
"custom_attributesV2": [AttributeValueInterface],
- "fax": "xyz789",
+ "fax": "abc123",
"firstname": "abc123",
"lastname": "abc123",
- "middlename": "xyz789",
+ "middlename": "abc123",
"postcode": "abc123",
- "prefix": "xyz789",
+ "prefix": "abc123",
"region": "abc123",
- "region_id": "4",
+ "region_id": 4,
"street": ["abc123"],
"suffix": "abc123",
- "telephone": "xyz789",
+ "telephone": "abc123",
"vat_id": "xyz789"
}
@@ -58597,68 +58844,11 @@ Fields
Example
{
"firstname": "xyz789",
- "lastname": "abc123",
+ "lastname": "xyz789",
"middlename": "xyz789",
- "prefix": "xyz789",
+ "prefix": "abc123",
"suffix": "xyz789"
}
-
-
-
- back to top
-
-
-
-
- Types
-
- OrderInformationInput
-
-
-
- Description
- Input to retrieve an order based on details.
-
-
-
-
-
- Example
- {
- "email": "abc123",
- "lastname": "abc123",
- "number": "abc123"
-}
@@ -58801,25 +58991,25 @@ Fields
Example
{
"discounts": [Discount],
- "eligible_for_return": true,
+ "eligible_for_return": false,
"entered_options": [OrderItemOption],
"gift_message": GiftMessage,
"gift_wrapping": GiftWrapping,
"id": "4",
"prices": OrderItemPrices,
"product": ProductInterface,
- "product_name": "abc123",
+ "product_name": "xyz789",
"product_sale_price": Money,
- "product_sku": "xyz789",
- "product_type": "xyz789",
+ "product_sku": "abc123",
+ "product_type": "abc123",
"product_url_key": "abc123",
"quantity_canceled": 987.65,
- "quantity_invoiced": 987.65,
+ "quantity_invoiced": 123.45,
"quantity_ordered": 123.45,
"quantity_refunded": 123.45,
- "quantity_return_requested": 987.65,
- "quantity_returned": 123.45,
- "quantity_shipped": 123.45,
+ "quantity_return_requested": 123.45,
+ "quantity_returned": 987.65,
+ "quantity_shipped": 987.65,
"selected_options": [OrderItemOption],
"status": "xyz789"
}
@@ -58979,12 +59169,12 @@ Possible Types
-
+
-
+
@@ -59006,24 +59196,24 @@ Possible Types
Example
{
"discounts": [Discount],
- "eligible_for_return": true,
+ "eligible_for_return": false,
"entered_options": [OrderItemOption],
"gift_message": GiftMessage,
"gift_wrapping": GiftWrapping,
- "id": "4",
+ "id": 4,
"prices": OrderItemPrices,
"product": ProductInterface,
- "product_name": "abc123",
+ "product_name": "xyz789",
"product_sale_price": Money,
- "product_sku": "abc123",
+ "product_sku": "xyz789",
"product_type": "abc123",
"product_url_key": "abc123",
- "quantity_canceled": 987.65,
- "quantity_invoiced": 987.65,
- "quantity_ordered": 987.65,
- "quantity_refunded": 987.65,
- "quantity_return_requested": 987.65,
- "quantity_returned": 987.65,
+ "quantity_canceled": 123.45,
+ "quantity_invoiced": 123.45,
+ "quantity_ordered": 123.45,
+ "quantity_refunded": 123.45,
+ "quantity_return_requested": 123.45,
+ "quantity_returned": 123.45,
"quantity_shipped": 987.65,
"selected_options": [OrderItemOption],
"status": "abc123"
@@ -59073,8 +59263,8 @@ Fields
Example
{
- "label": "abc123",
- "value": "xyz789"
+ "label": "xyz789",
+ "value": "abc123"
}
@@ -59227,7 +59417,7 @@ Example
{
"additional_data": [KeyValue],
"name": "xyz789",
- "type": "xyz789"
+ "type": "abc123"
}
@@ -59290,9 +59480,9 @@ Fields
Example
{
"comments": [SalesCommentItem],
- "id": "4",
+ "id": 4,
"items": [ShipmentItemInterface],
- "number": "abc123",
+ "number": "xyz789",
"tracking": [ShipmentTracking]
}
@@ -59335,7 +59525,7 @@ Fields
Example
- {"token": "xyz789"}
+ {"token": "abc123"}
@@ -59384,6 +59574,11 @@ Fields
The final total amount, including shipping, discounts, and taxes.
+
+ grand_total_excl_tax - Money!
+
+ The grand total of the order, excluding taxes.
+
shipping_handling - ShippingHandling
@@ -59447,6 +59642,7 @@ Example
"discounts": [Discount],
"gift_options": GiftOptionsPrices,
"grand_total": Money,
+ "grand_total_excl_tax": Money,
"shipping_handling": ShippingHandling,
"subtotal": Money,
"subtotal_excl_tax": Money,
@@ -59505,8 +59701,8 @@ Fields
Example
{
- "payer_id": "abc123",
- "token": "abc123"
+ "payer_id": "xyz789",
+ "token": "xyz789"
}
@@ -59561,9 +59757,9 @@ Fields
Example
{
- "cancel_url": "abc123",
+ "cancel_url": "xyz789",
"error_url": "xyz789",
- "return_url": "abc123"
+ "return_url": "xyz789"
}
@@ -59670,7 +59866,7 @@ Fields
Example
{
"mode": "TEST",
- "paypal_url": "xyz789",
+ "paypal_url": "abc123",
"secure_token": "xyz789",
"secure_token_id": "abc123"
}
@@ -59714,7 +59910,7 @@ Fields
Example
- {"cart_id": "abc123"}
+ {"cart_id": "xyz789"}
@@ -60047,6 +60243,11 @@ Possible Types
+
+
+
+
+
@@ -60055,12 +60256,12 @@ Possible Types
Example
{
- "code": "xyz789",
+ "code": "abc123",
"is_visible": false,
- "payment_intent": "xyz789",
+ "payment_intent": "abc123",
"sdk_params": [SDKParams],
"sort_order": "abc123",
- "title": "abc123"
+ "title": "xyz789"
}
@@ -60094,6 +60295,11 @@ Fields
ApplePay payment method configuration
+
+ fastlane - FastlaneConfig
+
+ Fastlane payment method configuration
+
google_pay - GooglePayConfig
@@ -60118,6 +60324,7 @@ Fields
Example
{
"apple_pay": ApplePayConfig,
+ "fastlane": FastlaneConfig,
"google_pay": GooglePayConfig,
"hosted_fields": HostedFieldsConfig,
"smart_buttons": SmartButtonsConfig
@@ -60177,6 +60384,13 @@ Values
+
+
+ START_OF_CHECKOUT
+
+
+
+
ADMIN
@@ -60317,6 +60531,12 @@ Fields
Required input for Apple Pay button
+
+
+ payment_services_paypal_fastlane - FastlaneMethodInput
+
+ Required input for fastlane
+
payment_services_paypal_google_pay - GooglePayMethodInput
@@ -60376,12 +60596,13 @@ Example
"payflowpro": PayflowProInput,
"payflowpro_cc_vault": VaultTokenInput,
"payment_services_paypal_apple_pay": ApplePayMethodInput,
+ "payment_services_paypal_fastlane": FastlaneMethodInput,
"payment_services_paypal_google_pay": GooglePayMethodInput,
"payment_services_paypal_hosted_fields": HostedFieldsInput,
"payment_services_paypal_smart_buttons": SmartButtonMethodInput,
"payment_services_paypal_vault": VaultMethodInput,
"paypal_express": PaypalExpressInput,
- "purchase_order_number": "xyz789"
+ "purchase_order_number": "abc123"
}
@@ -60441,7 +60662,7 @@ Example
"id": "xyz789",
"mp_order_id": "abc123",
"payment_source_details": PaymentSourceDetails,
- "status": "abc123"
+ "status": "xyz789"
}
@@ -60484,7 +60705,7 @@ Fields
Example
{
- "code": "abc123",
+ "code": "xyz789",
"params": [SDKParams]
}
@@ -60659,9 +60880,9 @@ Fields
Example
{
- "details": "xyz789",
- "payment_method_code": "xyz789",
- "public_hash": "xyz789",
+ "details": "abc123",
+ "payment_method_code": "abc123",
+ "public_hash": "abc123",
"type": "card"
}
@@ -60758,8 +60979,8 @@ Fields
Example
{
- "payer_id": "abc123",
- "token": "xyz789"
+ "payer_id": "xyz789",
+ "token": "abc123"
}
@@ -60826,9 +61047,9 @@ Fields
Example
{
- "cart_id": "xyz789",
- "code": "abc123",
- "express_button": true,
+ "cart_id": "abc123",
+ "code": "xyz789",
+ "express_button": false,
"urls": PaypalExpressUrlsInput,
"use_paypal_credit": true
}
@@ -60925,7 +61146,7 @@ Fields
Example
{
- "edit": "abc123",
+ "edit": "xyz789",
"start": "abc123"
}
@@ -60987,10 +61208,10 @@ Fields
Example
{
- "cancel_url": "xyz789",
+ "cancel_url": "abc123",
"pending_url": "abc123",
- "return_url": "xyz789",
- "success_url": "abc123"
+ "return_url": "abc123",
+ "success_url": "xyz789"
}
@@ -61194,11 +61415,11 @@ Fields
Example
{
- "city": "xyz789",
+ "city": "abc123",
"contact_name": "abc123",
- "country_id": "xyz789",
- "description": "abc123",
- "email": "abc123",
+ "country_id": "abc123",
+ "description": "xyz789",
+ "email": "xyz789",
"fax": "abc123",
"latitude": 123.45,
"longitude": 123.45,
@@ -61502,7 +61723,7 @@ Example
{
"items": [PickupLocation],
"page_info": SearchResultPageInfo,
- "total_count": 123
+ "total_count": 987
}
@@ -61544,7 +61765,7 @@ Fields
Example
- {"quote_uid": "4"}
+ {"quote_uid": 4}
@@ -61631,7 +61852,7 @@ Fields
Example
{
"code": "CART_NOT_FOUND",
- "message": "xyz789"
+ "message": "abc123"
}
@@ -61739,7 +61960,7 @@ Fields
Example
- {"purchase_order_uid": "4"}
+ {"purchase_order_uid": 4}
@@ -61820,7 +62041,7 @@ Fields
Example
- {"cart_id": "xyz789"}
+ {"cart_id": "abc123"}
@@ -61849,7 +62070,7 @@ Fields
- errors - [PlaceOrderError]!
+ errors - [PlaceOrderError]
An array of place order errors.
@@ -62222,7 +62443,7 @@ Fields
Example
{
"discount_percentage": 987.65,
- "main_final_price": 987.65,
+ "main_final_price": 123.45,
"main_price": 987.65
}
@@ -62424,7 +62645,7 @@ Fields
Example
{
"code": "xyz789",
- "value": "xyz789"
+ "value": "abc123"
}
@@ -62453,18 +62674,6 @@ Fields
-
-
- activity - FilterEqualTypeInput
-
- Attribute label: Activity
-
-
-
- category_gear - FilterEqualTypeInput
-
- Attribute label: Category Gear
-
category_id - FilterEqualTypeInput
@@ -62483,156 +62692,36 @@ Fields
Filter product by category URL path.
-
-
- climate - FilterEqualTypeInput
-
- Attribute label: Climate
-
-
-
- collar - FilterEqualTypeInput
-
- Attribute label: Collar
-
-
-
- color - FilterEqualTypeInput
-
- Attribute label: Color
-
description - FilterMatchTypeInput
Attribute label: Description
-
-
- eco_collection - FilterEqualTypeInput
-
- Attribute label: Eco Collection
-
-
-
- erin_recommends - FilterEqualTypeInput
-
- Attribute label: Erin Recommends
-
-
-
- features_bags - FilterEqualTypeInput
-
- Attribute label: Features
-
-
-
- format - FilterEqualTypeInput
-
- Attribute label: Format
-
-
-
- gender - FilterEqualTypeInput
-
- Attribute label: Gender
-
-
-
- material - FilterEqualTypeInput
-
- Attribute label: Material
-
name - FilterMatchTypeInput
Attribute label: Product Name
-
-
- new - FilterEqualTypeInput
-
- Attribute label: New
-
-
-
- pattern - FilterEqualTypeInput
-
- Attribute label: Pattern
-
-
-
- performance_fabric - FilterEqualTypeInput
-
- Attribute label: Performance Fabric
-
price - FilterRangeTypeInput
Attribute label: Price
-
-
- purpose - FilterEqualTypeInput
-
- Attribute label: Purpose
-
-
-
- sale - FilterEqualTypeInput
-
- Attribute label: Sale
-
short_description - FilterMatchTypeInput
Attribute label: Short Description
-
-
- size - FilterEqualTypeInput
-
- Attribute label: Size
-
sku - FilterEqualTypeInput
Attribute label: SKU
-
-
- sleeve - FilterEqualTypeInput
-
- Attribute label: Sleeve
-
-
-
- strap_bags - FilterEqualTypeInput
-
- Attribute label: Strap/Handle
-
-
-
- style_bags - FilterEqualTypeInput
-
- Attribute label: Style Bags
-
-
-
- style_bottom - FilterEqualTypeInput
-
- Attribute label: Style Bottom
-
-
-
- style_general - FilterEqualTypeInput
-
- Attribute label: Style General
-
url_key - FilterEqualTypeInput
@@ -62647,36 +62736,14 @@ Fields
Example
{
- "activity": FilterEqualTypeInput,
- "category_gear": FilterEqualTypeInput,
"category_id": FilterEqualTypeInput,
"category_uid": FilterEqualTypeInput,
"category_url_path": FilterEqualTypeInput,
- "climate": FilterEqualTypeInput,
- "collar": FilterEqualTypeInput,
- "color": FilterEqualTypeInput,
"description": FilterMatchTypeInput,
- "eco_collection": FilterEqualTypeInput,
- "erin_recommends": FilterEqualTypeInput,
- "features_bags": FilterEqualTypeInput,
- "format": FilterEqualTypeInput,
- "gender": FilterEqualTypeInput,
- "material": FilterEqualTypeInput,
"name": FilterMatchTypeInput,
- "new": FilterEqualTypeInput,
- "pattern": FilterEqualTypeInput,
- "performance_fabric": FilterEqualTypeInput,
"price": FilterRangeTypeInput,
- "purpose": FilterEqualTypeInput,
- "sale": FilterEqualTypeInput,
"short_description": FilterMatchTypeInput,
- "size": FilterEqualTypeInput,
"sku": FilterEqualTypeInput,
- "sleeve": FilterEqualTypeInput,
- "strap_bags": FilterEqualTypeInput,
- "style_bags": FilterEqualTypeInput,
- "style_bottom": FilterEqualTypeInput,
- "style_general": FilterEqualTypeInput,
"url_key": FilterEqualTypeInput
}
@@ -63183,6 +63250,11 @@ Fields
The media item's position after it has been sorted.
+
+ types - [String]
+
+ Array of image types. It can have the following values: image, small_image, thumbnail.
+
url - String
@@ -63196,10 +63268,11 @@ Fields
Example
{
- "disabled": false,
- "label": "xyz789",
- "position": 987,
- "url": "xyz789"
+ "disabled": true,
+ "label": "abc123",
+ "position": 123,
+ "types": ["xyz789"],
+ "url": "abc123"
}
@@ -63284,7 +63357,7 @@ Fields
Example
- {"sku": "xyz789"}
+ {"sku": "abc123"}
@@ -63312,13 +63385,6 @@ Fields
-
- activity - String
-
-
- Use the custom_attributes field instead.
-
-
attribute_set_id - Int
@@ -63335,27 +63401,6 @@ Fields
The categories assigned to a product.
-
- category_gear - String
-
-
- Use the custom_attributes field instead.
-
-
-
- climate - String
-
-
- Use the custom_attributes field instead.
-
-
-
- collar - String
-
-
- Use the custom_attributes field instead.
-
-
color - Int
@@ -63402,41 +63447,6 @@ filters
Detailed information about the product. The value can include simple HTML tags.
-
- eco_collection - Int
-
-
- Use the custom_attributes field instead.
-
-
-
- erin_recommends - Int
-
-
- Use the custom_attributes field instead.
-
-
-
- features_bags - String
-
-
- Use the custom_attributes field instead.
-
-
-
- format - Int
-
-
- Use the custom_attributes field instead.
-
-
-
- gender - String
-
-
- Use the custom_attributes field instead.
-
-
gift_message_available - Boolean!
@@ -63474,13 +63484,6 @@ filters
A number representing the product's manufacturer. Use the custom_attributes field instead.
-
- material - String
-
-
- Use the custom_attributes field instead.
-
-
max_sale_qty - Float
@@ -63522,13 +63525,6 @@ filters
The product name. Customers use this name to identify the product.
-
- new - Int
-
-
- Use the custom_attributes field instead.
-
-
new_from_date - String
@@ -63549,20 +63545,6 @@ filters
If the product has multiple options, determines where they appear on the product page.
-
- pattern - String
-
-
- Use the custom_attributes field instead.
-
-
-
- performance_fabric - Int
-
-
- Use the custom_attributes field instead.
-
-
price - ProductPrices
@@ -63584,13 +63566,6 @@ filters
An array of ProductLinks objects.
-
- purpose - Int
-
-
- Use the custom_attributes field instead.
-
-
quantity - Float
@@ -63635,42 +63610,16 @@ currentPage
-
- rules - [CatalogRule]
-
- Provides applied catalog rules in the current active cart
-
-
- sale - Int
-
-
- Use the custom_attributes field instead.
-
-
short_description - ComplexTextValue
A short description of the product. Its use depends on the theme.
-
- size - Int
-
-
- Use the custom_attributes field instead.
-
-
sku - String
A number or code assigned to a product to identify the product, options, price, and manufacturer.
-
- sleeve - String
-
-
- Use the custom_attributes field instead.
-
-
small_image - ProductImage
@@ -63702,34 +63651,6 @@ currentPage
Stock status of the product
-
- strap_bags - String
-
-
- Use the custom_attributes field instead.
-
-
-
- style_bags - String
-
-
- Use the custom_attributes field instead.
-
-
-
- style_bottom - String
-
-
- Use the custom_attributes field instead.
-
-
-
- style_general - String
-
-
- Use the custom_attributes field instead.
-
-
swatch_image - String
@@ -63831,12 +63752,12 @@ Possible Types
-
+
-
+
@@ -63857,82 +63778,60 @@ Possible Types
Example
{
- "activity": "xyz789",
- "attribute_set_id": 987,
- "canonical_url": "abc123",
+ "attribute_set_id": 123,
+ "canonical_url": "xyz789",
"categories": [CategoryInterface],
- "category_gear": "xyz789",
- "climate": "xyz789",
- "collar": "abc123",
"color": 123,
- "country_of_manufacture": "xyz789",
- "created_at": "xyz789",
+ "country_of_manufacture": "abc123",
+ "created_at": "abc123",
"crosssell_products": [ProductInterface],
"custom_attributesV2": ProductCustomAttributes,
"description": ComplexTextValue,
- "eco_collection": 123,
- "erin_recommends": 123,
- "features_bags": "abc123",
- "format": 123,
- "gender": "xyz789",
- "gift_message_available": false,
- "gift_wrapping_available": true,
+ "gift_message_available": true,
+ "gift_wrapping_available": false,
"gift_wrapping_price": Money,
"id": 987,
"image": ProductImage,
- "is_returnable": "abc123",
- "manufacturer": 987,
- "material": "abc123",
- "max_sale_qty": 987.65,
+ "is_returnable": "xyz789",
+ "manufacturer": 123,
+ "max_sale_qty": 123.45,
"media_gallery": [MediaGalleryInterface],
"media_gallery_entries": [MediaGalleryEntry],
"meta_description": "xyz789",
- "meta_keyword": "xyz789",
- "meta_title": "abc123",
+ "meta_keyword": "abc123",
+ "meta_title": "xyz789",
"min_sale_qty": 123.45,
"name": "abc123",
- "new": 987,
"new_from_date": "abc123",
"new_to_date": "xyz789",
- "only_x_left_in_stock": 987.65,
- "options_container": "abc123",
- "pattern": "xyz789",
- "performance_fabric": 987,
+ "only_x_left_in_stock": 123.45,
+ "options_container": "xyz789",
"price": ProductPrices,
"price_range": PriceRange,
"price_tiers": [TierPrice],
"product_links": [ProductLinksInterface],
- "purpose": 123,
"quantity": 987.65,
"rating_summary": 987.65,
"related_products": [ProductInterface],
- "review_count": 987,
+ "review_count": 123,
"reviews": ProductReviews,
- "rules": [CatalogRule],
- "sale": 987,
"short_description": ComplexTextValue,
- "size": 123,
- "sku": "xyz789",
- "sleeve": "xyz789",
+ "sku": "abc123",
"small_image": ProductImage,
- "special_from_date": "abc123",
+ "special_from_date": "xyz789",
"special_price": 987.65,
- "special_to_date": "abc123",
+ "special_to_date": "xyz789",
"staged": false,
"stock_status": "IN_STOCK",
- "strap_bags": "xyz789",
- "style_bags": "abc123",
- "style_bottom": "xyz789",
- "style_general": "abc123",
- "swatch_image": "abc123",
+ "swatch_image": "xyz789",
"thumbnail": ProductImage,
- "tier_price": 987.65,
+ "tier_price": 123.45,
"tier_prices": [ProductTierPrices],
- "type_id": "abc123",
+ "type_id": "xyz789",
"uid": "4",
- "updated_at": "abc123",
+ "updated_at": "xyz789",
"upsell_products": [ProductInterface],
- "url_key": "abc123",
+ "url_key": "xyz789",
"url_path": "xyz789",
"url_rewrites": [UrlRewrite],
"url_suffix": "abc123",
@@ -63998,11 +63897,11 @@ Fields
Example
{
- "link_type": "abc123",
- "linked_product_sku": "xyz789",
- "linked_product_type": "xyz789",
+ "link_type": "xyz789",
+ "linked_product_sku": "abc123",
+ "linked_product_type": "abc123",
"position": 987,
- "sku": "xyz789"
+ "sku": "abc123"
}
@@ -64139,7 +64038,7 @@ Example
{
"base64_encoded_data": "abc123",
"name": "abc123",
- "type": "abc123"
+ "type": "xyz789"
}
@@ -64207,11 +64106,11 @@ Fields
Example
{
"media_type": "abc123",
- "video_description": "abc123",
+ "video_description": "xyz789",
"video_metadata": "abc123",
"video_provider": "abc123",
"video_title": "xyz789",
- "video_url": "xyz789"
+ "video_url": "abc123"
}
@@ -64405,7 +64304,7 @@ Example
"nickname": "abc123",
"product": ProductInterface,
"ratings_breakdown": [ProductReviewRating],
- "summary": "abc123",
+ "summary": "xyz789",
"text": "abc123"
}
@@ -64453,7 +64352,7 @@ Fields
Example
{
- "name": "xyz789",
+ "name": "abc123",
"value": "xyz789"
}
@@ -64504,7 +64403,7 @@ Fields
Example
{
"id": "abc123",
- "value_id": "abc123"
+ "value_id": "xyz789"
}
@@ -64556,8 +64455,8 @@ Fields
Example
{
- "id": "xyz789",
- "name": "xyz789",
+ "id": "abc123",
+ "name": "abc123",
"values": [ProductReviewRatingValueMetadata]
}
@@ -64605,7 +64504,7 @@ Fields
Example
{
- "value": "abc123",
+ "value": "xyz789",
"value_id": "xyz789"
}
@@ -64811,7 +64710,7 @@ Fields
Example
{
"customer_group_id": "abc123",
- "percentage_value": 987.65,
+ "percentage_value": 123.45,
"qty": 123.45,
"value": 123.45,
"website_id": 123.45
@@ -64858,6 +64757,11 @@ Fields
The media item's position after it has been sorted.
+
+ types - [String]
+
+ Array of image types. It can have the following values: image, small_image, thumbnail.
+
url - String
@@ -64876,9 +64780,10 @@ Fields
Example
{
- "disabled": false,
- "label": "xyz789",
- "position": 123,
+ "disabled": true,
+ "label": "abc123",
+ "position": 987,
+ "types": ["xyz789"],
"url": "abc123",
"video_content": ProductMediaGalleryEntriesVideoContent
}
@@ -65079,7 +64984,7 @@ Example
"order": CustomerOrder,
"quote": Cart,
"status": "PENDING",
- "uid": 4,
+ "uid": "4",
"updated_at": "abc123"
}
@@ -65253,9 +65158,9 @@ Fields
Example
{
- "message": "abc123",
+ "message": "xyz789",
"name": "abc123",
- "role": "abc123",
+ "role": "xyz789",
"status": "PENDING",
"updated_at": "xyz789"
}
@@ -65402,9 +65307,9 @@ Example
"created_at": "abc123",
"created_by": "abc123",
"description": "xyz789",
- "name": "abc123",
+ "name": "xyz789",
"status": "ENABLED",
- "uid": 4,
+ "uid": "4",
"updated_at": "xyz789"
}
@@ -65708,8 +65613,8 @@ Fields
Example
{
- "applies_to": ["4"],
- "approvers": ["4"],
+ "applies_to": [4],
+ "approvers": [4],
"condition": CreatePurchaseOrderApprovalRuleConditionInput,
"description": "xyz789",
"name": "abc123",
@@ -65918,7 +65823,7 @@ Example
{
"items": [PurchaseOrderApprovalRule],
"page_info": SearchResultPageInfo,
- "total_count": 123
+ "total_count": 987
}
@@ -65976,8 +65881,8 @@ Fields
Example
{
"author": Customer,
- "created_at": "xyz789",
- "text": "xyz789",
+ "created_at": "abc123",
+ "text": "abc123",
"uid": 4
}
@@ -66101,10 +66006,10 @@ Fields
Example
{
- "activity": "xyz789",
- "created_at": "xyz789",
- "message": "abc123",
- "uid": 4
+ "activity": "abc123",
+ "created_at": "abc123",
+ "message": "xyz789",
+ "uid": "4"
}
@@ -66300,7 +66205,7 @@ Example
{
"items": [PurchaseOrder],
"page_info": SearchResultPageInfo,
- "total_count": 987
+ "total_count": 123
}
@@ -66555,9 +66460,9 @@ Fields
Example
{
- "item_id": 4,
- "note": "abc123",
- "templateId": "4"
+ "item_id": "4",
+ "note": "xyz789",
+ "templateId": 4
}
@@ -66604,8 +66509,8 @@ Fields
Example
{
- "message": "abc123",
- "type": "xyz789"
+ "message": "xyz789",
+ "type": "abc123"
}
@@ -66728,12 +66633,12 @@ Fields
Example
{
"badge_position": "xyz789",
- "language_code": "xyz789",
- "minimum_score": 123.45,
+ "language_code": "abc123",
+ "minimum_score": 987.65,
"re_captcha_type": "INVISIBLE",
- "technical_failure_message": "abc123",
+ "technical_failure_message": "xyz789",
"theme": "abc123",
- "validation_failure_message": "abc123",
+ "validation_failure_message": "xyz789",
"website_key": "abc123"
}
@@ -66811,13 +66716,13 @@ Fields
Example
{
- "badge_position": "xyz789",
- "failure_message": "xyz789",
+ "badge_position": "abc123",
+ "failure_message": "abc123",
"forms": ["PLACE_ORDER"],
- "is_enabled": true,
+ "is_enabled": false,
"language_code": "abc123",
"minimum_score": 987.65,
- "theme": "abc123",
+ "theme": "xyz789",
"website_key": "abc123"
}
@@ -67027,8 +66932,8 @@ Fields
Example
{
"code": "abc123",
- "id": 987,
- "name": "xyz789"
+ "id": 123,
+ "name": "abc123"
}
@@ -67070,7 +66975,7 @@ Fields
Example
- {"cart_id": "abc123"}
+ {"cart_id": "xyz789"}
@@ -67604,10 +67509,7 @@ Fields
Example
- {
- "item_uids": ["4"],
- "template_id": "4"
-}
+ {"item_uids": [4], "template_id": "4"}
@@ -67654,10 +67556,7 @@ Fields
Example
- {
- "products": ["4"],
- "uid": "4"
-}
+ {"products": [4], "uid": 4}
@@ -67867,7 +67766,7 @@ Fields
Example
- {"cart_id": "xyz789"}
+ {"cart_id": "abc123"}
@@ -67963,7 +67862,7 @@ Example
{
"quote_comment": "abc123",
"quote_name": "abc123",
- "quote_uid": "4"
+ "quote_uid": 4
}
@@ -68176,9 +68075,9 @@ Fields
Example
{
- "cart_id": "4",
+ "cart_id": 4,
"comment": NegotiableQuoteCommentInput,
- "is_draft": false,
+ "is_draft": true,
"quote_name": "abc123"
}
@@ -68261,7 +68160,7 @@ Fields
Example
- {"cart_id": 4}
+ {"cart_id": "4"}
@@ -68321,10 +68220,10 @@ Fields
Example
{
- "comment_text": "abc123",
- "contact_email": "abc123",
+ "comment_text": "xyz789",
+ "contact_email": "xyz789",
"items": [RequestReturnItemInput],
- "order_uid": 4
+ "order_uid": "4"
}
@@ -68389,7 +68288,7 @@ Example
EnteredCustomAttributeInput
],
"order_item_uid": "4",
- "quantity_to_return": 123.45,
+ "quantity_to_return": 987.65,
"selected_custom_attributes": [
SelectedCustomAttributeInput
]
@@ -68494,9 +68393,10 @@ Fields
Optional text that describes the requisition list.
- items - RequistionListItems
+ items - RequistionListItems
+
+ An array of products added to the requisition list. Deprecated. Use requisition_list_items instead. Will be removed in a future release.
- An array of products added to the requisition list.
@@ -68527,6 +68427,30 @@ pageSize
The requisition list name.
+
+ requisition_list_items - RequisitionListItems
+
+ An array of products added to the requisition list.
+
+
+
+
+
+
uid - ID!
@@ -68545,12 +68469,13 @@ pageSize
Example
{
- "description": "xyz789",
+ "description": "abc123",
"items": RequistionListItems,
"items_count": 987,
"name": "abc123",
+ "requisition_list_items": RequisitionListItems,
"uid": "4",
- "updated_at": "xyz789"
+ "updated_at": "abc123"
}
@@ -68701,8 +68626,62 @@ Example
{
"customizable_options": [SelectedCustomizableOption],
"product": ProductInterface,
- "quantity": 123.45,
- "uid": "4"
+ "quantity": 987.65,
+ "uid": 4
+}
+
+
+
+ back to top
+
+
+
+
+ Types
+
+ RequisitionListItems
+
+
+
+ Description
+ Contains an array of items added to a requisition list.
+
+
+ Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+ items - [RequisitionListItemInterface]!
+
+ An array of items in the requisition list.
+
+
+ page_info - SearchResultPageInfo
+
+ Pagination metadata.
+
+
+ total_pages - Int!
+
+ The number of pages returned.
+
+
+
+
+
+
+
+ Example
+ {
+ "items": [RequisitionListItemInterface],
+ "page_info": SearchResultPageInfo,
+ "total_pages": 987
}
@@ -68772,8 +68751,8 @@ Example
"entered_options": [EnteredOptionInput],
"parent_sku": "xyz789",
"quantity": 987.65,
- "selected_options": ["xyz789"],
- "sku": "abc123"
+ "selected_options": ["abc123"],
+ "sku": "xyz789"
}
@@ -68827,7 +68806,7 @@ Example
{
"items": [RequisitionList],
"page_info": SearchResultPageInfo,
- "total_count": 987
+ "total_count": 123
}
@@ -68844,7 +68823,7 @@ RequistionListItems
Description
- Contains an array of items added to a requisition list.
+ Deprecated. Use RequisitionListItems via requisition_list_items. Will be removed in a future release.
Fields
@@ -69034,9 +69013,9 @@ Fields
Example
{
- "author_name": "xyz789",
- "created_at": "abc123",
- "text": "abc123",
+ "author_name": "abc123",
+ "created_at": "xyz789",
+ "text": "xyz789",
"uid": 4
}
@@ -69089,9 +69068,9 @@ Fields
Example
{
- "label": "xyz789",
- "uid": 4,
- "value": "xyz789"
+ "label": "abc123",
+ "uid": "4",
+ "value": "abc123"
}
@@ -69143,7 +69122,7 @@ Fields
Example
{
- "email": "abc123",
+ "email": "xyz789",
"firstname": "abc123",
"lastname": "abc123"
}
@@ -69221,7 +69200,7 @@ Example
"custom_attributes": [ReturnCustomAttribute],
"custom_attributesV2": [AttributeValueInterface],
"order_item": OrderItemInterface,
- "quantity": 123.45,
+ "quantity": 987.65,
"request_quantity": 987.65,
"status": "PENDING",
"uid": "4"
@@ -69326,18 +69305,18 @@ Fields
Example
{
- "code": 4,
+ "code": "4",
"default_value": "abc123",
"entity_type": "CATALOG_PRODUCT",
"frontend_class": "xyz789",
"frontend_input": "BOOLEAN",
"input_filter": "NONE",
"is_required": false,
- "is_unique": true,
- "label": "xyz789",
- "multiline_count": 987,
+ "is_unique": false,
+ "label": "abc123",
+ "multiline_count": 123,
"options": [CustomAttributeOptionInterface],
- "sort_order": 987,
+ "sort_order": 123,
"validate_rules": [ValidationRule]
}
@@ -69545,12 +69524,12 @@ Fields
Example
{
"city": "xyz789",
- "contact_name": "xyz789",
+ "contact_name": "abc123",
"country": Country,
- "postcode": "xyz789",
+ "postcode": "abc123",
"region": Region,
"street": ["xyz789"],
- "telephone": "xyz789"
+ "telephone": "abc123"
}
@@ -69596,7 +69575,10 @@ Fields
Example
- {"label": "xyz789", "uid": 4}
+ {
+ "label": "abc123",
+ "uid": "4"
+}
@@ -69654,8 +69636,8 @@ Example
{
"carrier": ReturnShippingCarrier,
"status": ReturnShippingTrackingStatus,
- "tracking_number": "abc123",
- "uid": 4
+ "tracking_number": "xyz789",
+ "uid": "4"
}
@@ -69921,7 +69903,7 @@ Example
{
"items": [Return],
"page_info": SearchResultPageInfo,
- "total_count": 987
+ "total_count": 123
}
@@ -69962,7 +69944,7 @@ Fields
Example
- {"result": true}
+ {"result": false}
@@ -70063,7 +70045,7 @@ Fields
Example
- {"money": Money, "points": 987.65}
+ {"money": Money, "points": 123.45}
@@ -70122,7 +70104,7 @@ Example
"balance": RewardPointsAmount,
"change_reason": "xyz789",
"date": "abc123",
- "points_change": 987.65
+ "points_change": 123.45
}
@@ -70386,12 +70368,12 @@ Possible Types
-
+
-
+
@@ -70401,17 +70383,17 @@ Possible Types
-
+
-
+
-
+
@@ -70422,7 +70404,7 @@ Possible Types
Example
{
- "redirect_code": 987,
+ "redirect_code": 123,
"relative_url": "abc123",
"type": "CMS_PAGE"
}
@@ -70476,7 +70458,7 @@ Fields
Example
{
- "redirect_code": 987,
+ "redirect_code": 123,
"relative_url": "abc123",
"type": "CMS_PAGE"
}
@@ -70525,8 +70507,8 @@ Fields
Example
{
- "name": "xyz789",
- "value": "abc123"
+ "name": "abc123",
+ "value": "xyz789"
}
@@ -70573,7 +70555,7 @@ Fields
Example
{
- "message": "abc123",
+ "message": "xyz789",
"timestamp": "xyz789"
}
@@ -70681,7 +70663,7 @@ Fields
Example
- {"current_page": 123, "page_size": 123, "total_pages": 987}
+ {"current_page": 987, "page_size": 987, "total_pages": 123}
@@ -70784,7 +70766,7 @@ Fields
Example
{
- "id": 987,
+ "id": 123,
"label": "xyz789",
"type": "abc123",
"uid": 4,
@@ -70864,9 +70846,9 @@ Example
"id": 123,
"label": "abc123",
"original_price": Money,
- "price": 987.65,
+ "price": 123.45,
"priceV2": Money,
- "quantity": 987.65,
+ "quantity": 123.45,
"uid": 4
}
@@ -70939,9 +70921,9 @@ Fields
Example
{
"configurable_product_option_uid": "4",
- "configurable_product_option_value_uid": 4,
- "id": 123,
- "option_label": "xyz789",
+ "configurable_product_option_value_uid": "4",
+ "id": 987,
+ "option_label": "abc123",
"value_id": 123,
"value_label": "xyz789"
}
@@ -71067,7 +71049,7 @@ Fields
Example
{
- "customizable_option_uid": 4,
+ "customizable_option_uid": "4",
"id": 123,
"is_required": false,
"label": "abc123",
@@ -71138,8 +71120,8 @@ Fields
Example
{
"customizable_option_value_uid": "4",
- "id": 987,
- "label": "xyz789",
+ "id": 123,
+ "label": "abc123",
"price": CartItemSelectedOptionValuePrice,
"value": "xyz789"
}
@@ -71193,9 +71175,9 @@ Fields
Example
{
- "code": "abc123",
- "purchase_order_number": "xyz789",
- "title": "xyz789"
+ "code": "xyz789",
+ "purchase_order_number": "abc123",
+ "title": "abc123"
}
@@ -71276,8 +71258,8 @@ Example
{
"amount": Money,
"base_amount": Money,
- "carrier_code": "xyz789",
- "carrier_title": "abc123",
+ "carrier_code": "abc123",
+ "carrier_title": "xyz789",
"method_code": "xyz789",
"method_title": "abc123",
"price_excl_tax": Money,
@@ -71336,7 +71318,7 @@ Fields
Example
{
- "product_id": 123,
+ "product_id": 987,
"recipients": [SendEmailToFriendRecipientInput],
"sender": SendEmailToFriendSenderInput
}
@@ -71433,7 +71415,7 @@ Fields
Example
{
- "email": "xyz789",
+ "email": "abc123",
"name": "abc123"
}
@@ -71483,8 +71465,8 @@ Fields
Example
{
- "email": "xyz789",
- "name": "abc123"
+ "email": "abc123",
+ "name": "xyz789"
}
@@ -71537,8 +71519,8 @@ Fields
Example
{
"email": "abc123",
- "message": "xyz789",
- "name": "xyz789"
+ "message": "abc123",
+ "name": "abc123"
}
@@ -71641,7 +71623,7 @@ Fields
Example
- {"enabled_for_customers": false, "enabled_for_guests": true}
+ {"enabled_for_customers": true, "enabled_for_guests": false}
@@ -71688,10 +71670,7 @@ Fields
Example
- {
- "comment": NegotiableQuoteCommentInput,
- "quote_uid": "4"
-}
+ {"comment": NegotiableQuoteCommentInput, "quote_uid": 4}
@@ -71822,6 +71801,51 @@ Fields
Example
{"cart": Cart}
+
+
+
+ back to top
+
+
+
+
+ Types
+
+ SetCartAsInactiveOutput
+
+
+
+ Description
+ Sets the cart as inactive
+
+
+
+
+
+ Example
+ {"error": "xyz789", "success": true}
@@ -71887,10 +71911,10 @@ Fields
Example
{
- "cart_id": "xyz789",
+ "cart_id": "abc123",
"gift_message": GiftMessageInput,
"gift_receipt_included": true,
- "gift_wrapping_id": "4",
+ "gift_wrapping_id": 4,
"printed_card_included": false
}
@@ -71980,7 +72004,7 @@ Fields
Example
{
- "cart_id": "abc123",
+ "cart_id": "xyz789",
"email": "abc123"
}
@@ -72201,7 +72225,7 @@ Fields
Example
{
"payment_method": NegotiableQuotePaymentMethodInput,
- "quote_uid": 4
+ "quote_uid": "4"
}
@@ -72296,8 +72320,8 @@ Fields
Example
{
- "customer_address_id": "4",
- "quote_uid": 4,
+ "customer_address_id": 4,
+ "quote_uid": "4",
"shipping_addresses": [
NegotiableQuoteShippingAddressInput
]
@@ -72529,7 +72553,7 @@ Fields
Example
{
- "cart_id": "abc123",
+ "cart_id": "xyz789",
"payment_method": PaymentMethodInput
}
@@ -72669,7 +72693,7 @@ Fields
Example
{
- "cart_id": "xyz789",
+ "cart_id": "abc123",
"shipping_addresses": [ShippingAddressInput]
}
@@ -72759,7 +72783,7 @@ Fields
Example
{
- "cart_id": "xyz789",
+ "cart_id": "abc123",
"shipping_methods": [ShippingMethodInput]
}
@@ -73052,9 +73076,9 @@ Fields
Example
{
- "id": "4",
+ "id": 4,
"order_item": OrderItemInterface,
- "product_name": "abc123",
+ "product_name": "xyz789",
"product_sale_price": Money,
"product_sku": "abc123",
"quantity_shipped": 987.65
@@ -73156,7 +73180,7 @@ Example
"product_name": "abc123",
"product_sale_price": Money,
"product_sku": "abc123",
- "quantity_shipped": 123.45
+ "quantity_shipped": 987.65
}
@@ -73208,7 +73232,7 @@ Fields
Example
{
- "carrier": "abc123",
+ "carrier": "xyz789",
"number": "xyz789",
"title": "abc123"
}
@@ -73251,6 +73275,12 @@ Fields
An ID from the customer's address book that uniquely identifies the address to be used for shipping.
+
+
+ customer_address_uid - ID
+
+ The unique ID from the customer's address book that uniquely identifies the address to be used for shipping.
+
customer_notes - String
@@ -73272,9 +73302,10 @@ Fields
Example
{
"address": CartAddressInput,
- "customer_address_id": 123,
- "customer_notes": "xyz789",
- "pickup_location_code": "xyz789"
+ "customer_address_id": 987,
+ "customer_address_uid": 4,
+ "customer_notes": "abc123",
+ "pickup_location_code": "abc123"
}
@@ -73340,6 +73371,11 @@ Fields
The custom attribute values of the billing or shipping address.
+
+ customer_address_uid - ID
+
+ The unique ID from the customer's address book that uniquely identifies the address.
+
customer_notes - String
@@ -73356,9 +73392,10 @@ Fields
The first name of the customer or guest.
- id - Int
+ id - Int
+
+ Id of the customer address. Use customer_address_uid instead.
- Id of the customer address.
items_weight - Float
@@ -73424,9 +73461,9 @@ Fields
The telephone number for the billing or shipping address.
- uid - String!
+ uid - ID!
- The unique id of the customer address.
+ The unique id of the customer cart address.
vat_id - String
@@ -73444,27 +73481,28 @@ Example
"available_shipping_methods": [AvailableShippingMethod],
"cart_items": [CartItemQuantity],
"cart_items_v2": [CartItemInterface],
- "city": "abc123",
- "company": "xyz789",
+ "city": "xyz789",
+ "company": "abc123",
"country": CartAddressCountry,
"custom_attributes": [AttributeValueInterface],
+ "customer_address_uid": 4,
"customer_notes": "xyz789",
- "fax": "xyz789",
+ "fax": "abc123",
"firstname": "xyz789",
- "id": 987,
+ "id": 123,
"items_weight": 987.65,
- "lastname": "xyz789",
- "middlename": "xyz789",
+ "lastname": "abc123",
+ "middlename": "abc123",
"pickup_location_code": "xyz789",
- "postcode": "xyz789",
+ "postcode": "abc123",
"prefix": "abc123",
"region": CartAddressRegion,
- "same_as_billing": false,
+ "same_as_billing": true,
"selected_shipping_method": SelectedShippingMethod,
- "street": ["xyz789"],
+ "street": ["abc123"],
"suffix": "xyz789",
"telephone": "xyz789",
- "uid": "xyz789",
+ "uid": 4,
"vat_id": "abc123"
}
@@ -73751,16 +73789,16 @@ Example
"errors": [CartItemError],
"gift_message": GiftMessage,
"gift_wrapping": GiftWrapping,
- "id": "abc123",
- "is_available": false,
- "max_qty": 123.45,
- "min_qty": 123.45,
+ "id": "xyz789",
+ "is_available": true,
+ "max_qty": 987.65,
+ "min_qty": 987.65,
"not_available_message": "xyz789",
"note_from_buyer": [ItemNote],
"note_from_seller": [ItemNote],
"prices": CartItemPrices,
"product": ProductInterface,
- "quantity": 123.45,
+ "quantity": 987.65,
"uid": 4
}
@@ -73790,13 +73828,6 @@ Fields
-
- activity - String
-
-
- Use the custom_attributes field instead.
-
-
attribute_set_id - Int
@@ -73813,27 +73844,6 @@ Fields
The categories assigned to a product.
-
- category_gear - String
-
-
- Use the custom_attributes field instead.
-
-
-
- climate - String
-
-
- Use the custom_attributes field instead.
-
-
-
- collar - String
-
-
- Use the custom_attributes field instead.
-
-
color - Int
@@ -73880,41 +73890,6 @@ filters
Detailed information about the product. The value can include simple HTML tags.
-
- eco_collection - Int
-
-
- Use the custom_attributes field instead.
-
-
-
- erin_recommends - Int
-
-
- Use the custom_attributes field instead.
-
-
-
- features_bags - String
-
-
- Use the custom_attributes field instead.
-
-
-
- format - Int
-
-
- Use the custom_attributes field instead.
-
-
-
- gender - String
-
-
- Use the custom_attributes field instead.
-
-
gift_message_available - Boolean!
@@ -73952,13 +73927,6 @@ filters
A number representing the product's manufacturer. Use the custom_attributes field instead.
-
- material - String
-
-
- Use the custom_attributes field instead.
-
-
max_sale_qty - Float
@@ -74000,13 +73968,6 @@ filters
The product name. Customers use this name to identify the product.
-
- new - Int
-
-
- Use the custom_attributes field instead.
-
-
new_from_date - String
@@ -74032,20 +73993,6 @@ filters
If the product has multiple options, determines where they appear on the product page.
-
- pattern - String
-
-
- Use the custom_attributes field instead.
-
-
-
- performance_fabric - Int
-
-
- Use the custom_attributes field instead.
-
-
price - ProductPrices
@@ -74067,13 +74014,6 @@ filters
An array of ProductLinks objects.
-
- purpose - Int
-
-
- Use the custom_attributes field instead.
-
-
quantity - Float
@@ -74128,42 +74068,16 @@ currentPage
-
- rules - [CatalogRule]
-
- Provides applied catalog rules in the current active cart
-
-
- sale - Int
-
-
- Use the custom_attributes field instead.
-
-
short_description - ComplexTextValue
A short description of the product. Its use depends on the theme.
-
- size - Int
-
-
- Use the custom_attributes field instead.
-
-
sku - String
A number or code assigned to a product to identify the product, options, price, and manufacturer.
-
- sleeve - String
-
-
- Use the custom_attributes field instead.
-
-
small_image - ProductImage
@@ -74195,34 +74109,6 @@ currentPage
Stock status of the product
-
- strap_bags - String
-
-
- Use the custom_attributes field instead.
-
-
-
- style_bags - String
-
-
- Use the custom_attributes field instead.
-
-
-
- style_bottom - String
-
-
- Use the custom_attributes field instead.
-
-
-
- style_general - String
-
-
- Use the custom_attributes field instead.
-
-
swatch_image - String
@@ -74313,91 +74199,69 @@ currentPage
Example
{
- "activity": "abc123",
- "attribute_set_id": 987,
+ "attribute_set_id": 123,
"canonical_url": "xyz789",
"categories": [CategoryInterface],
- "category_gear": "xyz789",
- "climate": "xyz789",
- "collar": "abc123",
- "color": 123,
- "country_of_manufacture": "xyz789",
- "created_at": "abc123",
+ "color": 987,
+ "country_of_manufacture": "abc123",
+ "created_at": "xyz789",
"crosssell_products": [ProductInterface],
"custom_attributesV2": ProductCustomAttributes,
"description": ComplexTextValue,
- "eco_collection": 123,
- "erin_recommends": 987,
- "features_bags": "xyz789",
- "format": 123,
- "gender": "xyz789",
- "gift_message_available": true,
+ "gift_message_available": false,
"gift_wrapping_available": true,
"gift_wrapping_price": Money,
"id": 987,
"image": ProductImage,
- "is_returnable": "xyz789",
+ "is_returnable": "abc123",
"manufacturer": 987,
- "material": "xyz789",
- "max_sale_qty": 987.65,
+ "max_sale_qty": 123.45,
"media_gallery": [MediaGalleryInterface],
"media_gallery_entries": [MediaGalleryEntry],
- "meta_description": "xyz789",
- "meta_keyword": "xyz789",
+ "meta_description": "abc123",
+ "meta_keyword": "abc123",
"meta_title": "xyz789",
"min_sale_qty": 987.65,
"name": "xyz789",
- "new": 123,
"new_from_date": "xyz789",
- "new_to_date": "xyz789",
- "only_x_left_in_stock": 123.45,
+ "new_to_date": "abc123",
+ "only_x_left_in_stock": 987.65,
"options": [CustomizableOptionInterface],
"options_container": "xyz789",
- "pattern": "xyz789",
- "performance_fabric": 123,
"price": ProductPrices,
"price_range": PriceRange,
"price_tiers": [TierPrice],
"product_links": [ProductLinksInterface],
- "purpose": 987,
"quantity": 123.45,
"rating_summary": 987.65,
"redirect_code": 987,
"related_products": [ProductInterface],
- "relative_url": "xyz789",
+ "relative_url": "abc123",
"review_count": 123,
"reviews": ProductReviews,
- "rules": [CatalogRule],
- "sale": 987,
"short_description": ComplexTextValue,
- "size": 123,
"sku": "abc123",
- "sleeve": "abc123",
"small_image": ProductImage,
- "special_from_date": "abc123",
- "special_price": 987.65,
+ "special_from_date": "xyz789",
+ "special_price": 123.45,
"special_to_date": "xyz789",
"staged": false,
"stock_status": "IN_STOCK",
- "strap_bags": "abc123",
- "style_bags": "abc123",
- "style_bottom": "xyz789",
- "style_general": "xyz789",
- "swatch_image": "xyz789",
+ "swatch_image": "abc123",
"thumbnail": ProductImage,
- "tier_price": 987.65,
+ "tier_price": 123.45,
"tier_prices": [ProductTierPrices],
"type": "CMS_PAGE",
- "type_id": "xyz789",
- "uid": "4",
+ "type_id": "abc123",
+ "uid": 4,
"updated_at": "xyz789",
"upsell_products": [ProductInterface],
- "url_key": "xyz789",
- "url_path": "xyz789",
+ "url_key": "abc123",
+ "url_path": "abc123",
"url_rewrites": [UrlRewrite],
- "url_suffix": "xyz789",
+ "url_suffix": "abc123",
"websites": [Website],
- "weight": 987.65
+ "weight": 123.45
}
@@ -74506,8 +74370,8 @@ Example
{
"customizable_options": [SelectedCustomizableOption],
"product": ProductInterface,
- "quantity": 123.45,
- "uid": 4
+ "quantity": 987.65,
+ "uid": "4"
}
@@ -74579,7 +74443,7 @@ Example
"description": "abc123",
"id": 4,
"product": ProductInterface,
- "quantity": 987.65
+ "quantity": 123.45
}
@@ -74635,7 +74499,7 @@ Fields
Example
{
"payment_source": "abc123",
- "payments_order_id": "xyz789",
+ "payments_order_id": "abc123",
"paypal_order_id": "abc123"
}
@@ -74661,6 +74525,11 @@ Fields
+
+ app_switch_when_available - Boolean
+
+ Indicated whether to use App Switch on enabled mobile devices
+
button_styles - ButtonStyles
@@ -74719,15 +74588,16 @@ Fields
Example
{
+ "app_switch_when_available": false,
"button_styles": ButtonStyles,
"code": "xyz789",
- "display_message": true,
+ "display_message": false,
"display_venmo": true,
- "is_visible": false,
+ "is_visible": true,
"message_styles": MessageStyles,
- "payment_intent": "abc123",
+ "payment_intent": "xyz789",
"sdk_params": [SDKParams],
- "sort_order": "abc123",
+ "sort_order": "xyz789",
"title": "xyz789"
}
@@ -74824,7 +74694,7 @@ Fields
Example
{
- "label": "xyz789",
+ "label": "abc123",
"value": "xyz789"
}
@@ -74872,7 +74742,7 @@ Fields
Example
{
- "default": "xyz789",
+ "default": "abc123",
"options": [SortField]
}
@@ -75633,6 +75503,11 @@ Fields
Indicates if gift wrapping prices are displayed on the Shopping Cart page. Possible values: 1 (Yes) and 0 (No).
+
+ cart_merge_preference - String!
+
+ Configuration data from checkout/cart/cart_merge_preference
+
cart_printed_card - String
@@ -75855,12 +75730,7 @@ Fields
The landing page that is associated with the base URL.
- graphql_share_all_customer_groups - Boolean!
-
- Configuration data from customer/account_information/graphql_share_all_customer_groups
-
-
- graphql_share_customer_group - Boolean!
+ graphql_share_customer_group - Boolean
Configuration data from customer/account_information/graphql_share_customer_group
@@ -76218,24 +76088,14 @@ Fields
Email to a Friend configuration.
- share_all_catalog_rules - Boolean!
-
- Configuration data from catalog/rule/share_all_catalog_rules
-
-
- share_all_sales_rule - Boolean!
-
- Configuration data from promo/graphql/share_all_sales_rule
-
-
- share_applied_catalog_rules - Boolean!
+ share_active_segments - Boolean
- Configuration data from catalog/rule/share_applied_catalog_rules
+ Configuration data from customer/magento_customersegment/share_active_segments
- share_applied_sales_rule - Boolean!
+ share_applied_cart_rule - Boolean
- Configuration data from promo/graphql/share_applied_sales_rule
+ Configuration data from promo/graphql/share_applied_cart_rule
shopping_cart_display_full_summary - Boolean
@@ -76397,48 +76257,48 @@ Fields
Example
{
"absolute_footer": "abc123",
- "allow_gift_receipt": "xyz789",
- "allow_gift_wrapping_on_order": "xyz789",
+ "allow_gift_receipt": "abc123",
+ "allow_gift_wrapping_on_order": "abc123",
"allow_gift_wrapping_on_order_items": "abc123",
- "allow_guests_to_write_product_reviews": "xyz789",
+ "allow_guests_to_write_product_reviews": "abc123",
"allow_items": "xyz789",
"allow_order": "xyz789",
"allow_printed_card": "abc123",
- "autocomplete_on_storefront": false,
- "base_currency_code": "abc123",
+ "autocomplete_on_storefront": true,
+ "base_currency_code": "xyz789",
"base_link_url": "abc123",
- "base_media_url": "abc123",
+ "base_media_url": "xyz789",
"base_static_url": "abc123",
- "base_url": "xyz789",
+ "base_url": "abc123",
"braintree_3dsecure_allowspecific": false,
- "braintree_3dsecure_always_request_3ds": true,
+ "braintree_3dsecure_always_request_3ds": false,
"braintree_3dsecure_specificcountry": "abc123",
- "braintree_3dsecure_threshold_amount": "xyz789",
- "braintree_3dsecure_verify_3dsecure": false,
+ "braintree_3dsecure_threshold_amount": "abc123",
+ "braintree_3dsecure_verify_3dsecure": true,
"braintree_ach_direct_debit_vault_active": true,
- "braintree_applepay_merchant_name": "abc123",
- "braintree_applepay_vault_active": true,
- "braintree_cc_vault_active": "xyz789",
+ "braintree_applepay_merchant_name": "xyz789",
+ "braintree_applepay_vault_active": false,
+ "braintree_cc_vault_active": "abc123",
"braintree_cc_vault_cvv": false,
"braintree_environment": "abc123",
- "braintree_googlepay_btn_color": "xyz789",
+ "braintree_googlepay_btn_color": "abc123",
"braintree_googlepay_cctypes": "abc123",
"braintree_googlepay_merchant_id": "xyz789",
"braintree_googlepay_vault_active": false,
"braintree_local_payment_allowed_methods": "xyz789",
"braintree_local_payment_fallback_button_text": "abc123",
"braintree_local_payment_redirect_on_fail": "xyz789",
- "braintree_merchant_account_id": "abc123",
+ "braintree_merchant_account_id": "xyz789",
"braintree_paypal_button_location_cart_type_credit_color": "abc123",
"braintree_paypal_button_location_cart_type_credit_label": "abc123",
- "braintree_paypal_button_location_cart_type_credit_shape": "abc123",
- "braintree_paypal_button_location_cart_type_credit_show": true,
- "braintree_paypal_button_location_cart_type_messaging_layout": "xyz789",
+ "braintree_paypal_button_location_cart_type_credit_shape": "xyz789",
+ "braintree_paypal_button_location_cart_type_credit_show": false,
+ "braintree_paypal_button_location_cart_type_messaging_layout": "abc123",
"braintree_paypal_button_location_cart_type_messaging_logo": "abc123",
"braintree_paypal_button_location_cart_type_messaging_logo_position": "abc123",
"braintree_paypal_button_location_cart_type_messaging_show": false,
- "braintree_paypal_button_location_cart_type_messaging_text_color": "xyz789",
- "braintree_paypal_button_location_cart_type_paylater_color": "abc123",
+ "braintree_paypal_button_location_cart_type_messaging_text_color": "abc123",
+ "braintree_paypal_button_location_cart_type_paylater_color": "xyz789",
"braintree_paypal_button_location_cart_type_paylater_label": "xyz789",
"braintree_paypal_button_location_cart_type_paylater_shape": "abc123",
"braintree_paypal_button_location_cart_type_paylater_show": true,
@@ -76447,198 +76307,196 @@ Example
"braintree_paypal_button_location_cart_type_paypal_shape": "abc123",
"braintree_paypal_button_location_cart_type_paypal_show": true,
"braintree_paypal_button_location_checkout_type_credit_color": "abc123",
- "braintree_paypal_button_location_checkout_type_credit_label": "abc123",
- "braintree_paypal_button_location_checkout_type_credit_shape": "abc123",
- "braintree_paypal_button_location_checkout_type_credit_show": true,
+ "braintree_paypal_button_location_checkout_type_credit_label": "xyz789",
+ "braintree_paypal_button_location_checkout_type_credit_shape": "xyz789",
+ "braintree_paypal_button_location_checkout_type_credit_show": false,
"braintree_paypal_button_location_checkout_type_messaging_layout": "xyz789",
- "braintree_paypal_button_location_checkout_type_messaging_logo": "abc123",
+ "braintree_paypal_button_location_checkout_type_messaging_logo": "xyz789",
"braintree_paypal_button_location_checkout_type_messaging_logo_position": "xyz789",
- "braintree_paypal_button_location_checkout_type_messaging_show": false,
+ "braintree_paypal_button_location_checkout_type_messaging_show": true,
"braintree_paypal_button_location_checkout_type_messaging_text_color": "xyz789",
- "braintree_paypal_button_location_checkout_type_paylater_color": "abc123",
+ "braintree_paypal_button_location_checkout_type_paylater_color": "xyz789",
"braintree_paypal_button_location_checkout_type_paylater_label": "abc123",
- "braintree_paypal_button_location_checkout_type_paylater_shape": "xyz789",
- "braintree_paypal_button_location_checkout_type_paylater_show": true,
+ "braintree_paypal_button_location_checkout_type_paylater_shape": "abc123",
+ "braintree_paypal_button_location_checkout_type_paylater_show": false,
"braintree_paypal_button_location_checkout_type_paypal_color": "abc123",
- "braintree_paypal_button_location_checkout_type_paypal_label": "xyz789",
- "braintree_paypal_button_location_checkout_type_paypal_shape": "abc123",
- "braintree_paypal_button_location_checkout_type_paypal_show": false,
- "braintree_paypal_button_location_productpage_type_credit_color": "xyz789",
+ "braintree_paypal_button_location_checkout_type_paypal_label": "abc123",
+ "braintree_paypal_button_location_checkout_type_paypal_shape": "xyz789",
+ "braintree_paypal_button_location_checkout_type_paypal_show": true,
+ "braintree_paypal_button_location_productpage_type_credit_color": "abc123",
"braintree_paypal_button_location_productpage_type_credit_label": "xyz789",
"braintree_paypal_button_location_productpage_type_credit_shape": "abc123",
"braintree_paypal_button_location_productpage_type_credit_show": false,
- "braintree_paypal_button_location_productpage_type_messaging_layout": "xyz789",
+ "braintree_paypal_button_location_productpage_type_messaging_layout": "abc123",
"braintree_paypal_button_location_productpage_type_messaging_logo": "xyz789",
"braintree_paypal_button_location_productpage_type_messaging_logo_position": "abc123",
- "braintree_paypal_button_location_productpage_type_messaging_show": false,
- "braintree_paypal_button_location_productpage_type_messaging_text_color": "abc123",
+ "braintree_paypal_button_location_productpage_type_messaging_show": true,
+ "braintree_paypal_button_location_productpage_type_messaging_text_color": "xyz789",
"braintree_paypal_button_location_productpage_type_paylater_color": "xyz789",
- "braintree_paypal_button_location_productpage_type_paylater_label": "xyz789",
+ "braintree_paypal_button_location_productpage_type_paylater_label": "abc123",
"braintree_paypal_button_location_productpage_type_paylater_shape": "abc123",
- "braintree_paypal_button_location_productpage_type_paylater_show": false,
+ "braintree_paypal_button_location_productpage_type_paylater_show": true,
"braintree_paypal_button_location_productpage_type_paypal_color": "xyz789",
"braintree_paypal_button_location_productpage_type_paypal_label": "xyz789",
- "braintree_paypal_button_location_productpage_type_paypal_shape": "xyz789",
+ "braintree_paypal_button_location_productpage_type_paypal_shape": "abc123",
"braintree_paypal_button_location_productpage_type_paypal_show": false,
"braintree_paypal_credit_uk_merchant_name": "xyz789",
- "braintree_paypal_display_on_shopping_cart": false,
- "braintree_paypal_merchant_country": "xyz789",
- "braintree_paypal_merchant_name_override": "abc123",
+ "braintree_paypal_display_on_shopping_cart": true,
+ "braintree_paypal_merchant_country": "abc123",
+ "braintree_paypal_merchant_name_override": "xyz789",
"braintree_paypal_require_billing_address": false,
- "braintree_paypal_send_cart_line_items": false,
+ "braintree_paypal_send_cart_line_items": true,
"braintree_paypal_vault_active": false,
- "cart_expires_in_days": 987,
+ "cart_expires_in_days": 123,
"cart_gift_wrapping": "xyz789",
- "cart_printed_card": "xyz789",
+ "cart_merge_preference": "abc123",
+ "cart_printed_card": "abc123",
"cart_summary_display_quantity": 123,
"catalog_default_sort_by": "xyz789",
"category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
- "category_url_suffix": "xyz789",
- "check_money_order_enable_for_specific_countries": false,
+ "category_url_suffix": "abc123",
+ "check_money_order_enable_for_specific_countries": true,
"check_money_order_enabled": true,
- "check_money_order_make_check_payable_to": "xyz789",
- "check_money_order_max_order_total": "xyz789",
- "check_money_order_min_order_total": "xyz789",
+ "check_money_order_make_check_payable_to": "abc123",
+ "check_money_order_max_order_total": "abc123",
+ "check_money_order_min_order_total": "abc123",
"check_money_order_new_order_status": "xyz789",
"check_money_order_payment_from_specific_countries": "abc123",
- "check_money_order_send_check_to": "xyz789",
- "check_money_order_sort_order": 123,
- "check_money_order_title": "abc123",
+ "check_money_order_send_check_to": "abc123",
+ "check_money_order_sort_order": 987,
+ "check_money_order_title": "xyz789",
"cms_home_page": "abc123",
- "cms_no_cookies": "abc123",
- "cms_no_route": "xyz789",
+ "cms_no_cookies": "xyz789",
+ "cms_no_route": "abc123",
"code": "abc123",
"configurable_product_image": "ITSELF",
"configurable_thumbnail_source": "xyz789",
- "contact_enabled": false,
- "copyright": "abc123",
- "countries_with_required_region": "xyz789",
+ "contact_enabled": true,
+ "copyright": "xyz789",
+ "countries_with_required_region": "abc123",
"create_account_confirmation": true,
"customer_access_token_lifetime": 123.45,
- "default_country": "abc123",
+ "default_country": "xyz789",
"default_description": "xyz789",
"default_display_currency_code": "abc123",
"default_keywords": "xyz789",
- "default_title": "xyz789",
+ "default_title": "abc123",
"demonotice": 123,
"display_product_prices_in_catalog": 987,
"display_shipping_prices": 123,
- "display_state_if_optional": false,
+ "display_state_if_optional": true,
"enable_multiple_wishlists": "abc123",
"fixed_product_taxes_apply_tax_to_fpt": false,
"fixed_product_taxes_display_prices_in_emails": 987,
"fixed_product_taxes_display_prices_in_product_lists": 987,
"fixed_product_taxes_display_prices_in_sales_modules": 123,
- "fixed_product_taxes_display_prices_on_product_view_page": 987,
- "fixed_product_taxes_enable": false,
- "fixed_product_taxes_include_fpt_in_subtotal": true,
- "front": "abc123",
- "graphql_share_all_customer_groups": false,
+ "fixed_product_taxes_display_prices_on_product_view_page": 123,
+ "fixed_product_taxes_enable": true,
+ "fixed_product_taxes_include_fpt_in_subtotal": false,
+ "front": "xyz789",
"graphql_share_customer_group": true,
- "grid_per_page": 987,
+ "grid_per_page": 123,
"grid_per_page_values": "xyz789",
"grouped_product_image": "ITSELF",
- "head_includes": "xyz789",
- "head_shortcut_icon": "xyz789",
+ "head_includes": "abc123",
+ "head_shortcut_icon": "abc123",
"header_logo_src": "abc123",
- "id": 123,
- "is_checkout_agreements_enabled": true,
+ "id": 987,
+ "is_checkout_agreements_enabled": false,
"is_default_store": true,
- "is_default_store_group": false,
- "is_guest_checkout_enabled": true,
+ "is_default_store_group": true,
+ "is_guest_checkout_enabled": false,
"is_negotiable_quote_active": false,
- "is_one_page_checkout_enabled": false,
+ "is_one_page_checkout_enabled": true,
"is_requisition_list_active": "abc123",
"list_mode": "xyz789",
"list_per_page": 987,
- "list_per_page_values": "xyz789",
- "locale": "abc123",
+ "list_per_page_values": "abc123",
+ "locale": "xyz789",
"logo_alt": "xyz789",
"logo_height": 987,
- "logo_width": 123,
- "magento_reward_general_is_enabled": "xyz789",
+ "logo_width": 987,
+ "magento_reward_general_is_enabled": "abc123",
"magento_reward_general_is_enabled_on_front": "abc123",
"magento_reward_general_min_points_balance": "abc123",
- "magento_reward_general_publish_history": "xyz789",
+ "magento_reward_general_publish_history": "abc123",
"magento_reward_points_invitation_customer": "xyz789",
- "magento_reward_points_invitation_customer_limit": "xyz789",
+ "magento_reward_points_invitation_customer_limit": "abc123",
"magento_reward_points_invitation_order": "abc123",
- "magento_reward_points_invitation_order_limit": "abc123",
- "magento_reward_points_newsletter": "xyz789",
+ "magento_reward_points_invitation_order_limit": "xyz789",
+ "magento_reward_points_newsletter": "abc123",
"magento_reward_points_order": "xyz789",
- "magento_reward_points_register": "abc123",
- "magento_reward_points_review": "xyz789",
- "magento_reward_points_review_limit": "xyz789",
- "magento_wishlist_general_is_enabled": "xyz789",
- "max_items_in_order_summary": 987,
+ "magento_reward_points_register": "xyz789",
+ "magento_reward_points_review": "abc123",
+ "magento_reward_points_review_limit": "abc123",
+ "magento_wishlist_general_is_enabled": "abc123",
+ "max_items_in_order_summary": 123,
"maximum_number_of_wishlists": "xyz789",
"minicart_display": true,
- "minicart_max_items": 123,
+ "minicart_max_items": 987,
"minimum_password_length": "xyz789",
"newsletter_enabled": true,
- "no_route": "xyz789",
- "optional_zip_countries": "abc123",
+ "no_route": "abc123",
+ "optional_zip_countries": "xyz789",
"order_cancellation_enabled": false,
"order_cancellation_reasons": [CancellationReason],
- "orders_invoices_credit_memos_display_full_summary": true,
+ "orders_invoices_credit_memos_display_full_summary": false,
"orders_invoices_credit_memos_display_grandtotal": false,
"orders_invoices_credit_memos_display_price": 987,
"orders_invoices_credit_memos_display_shipping_amount": 123,
- "orders_invoices_credit_memos_display_subtotal": 123,
+ "orders_invoices_credit_memos_display_subtotal": 987,
"orders_invoices_credit_memos_display_zero_tax": true,
"payment_payflowpro_cc_vault_active": "xyz789",
- "printed_card_price": "xyz789",
+ "printed_card_price": "abc123",
"printed_card_priceV2": Money,
"product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
- "product_reviews_enabled": "xyz789",
+ "product_reviews_enabled": "abc123",
"product_url_suffix": "abc123",
"quickorder_active": true,
- "required_character_classes_number": "abc123",
- "returns_enabled": "xyz789",
- "root_category_id": 123,
+ "required_character_classes_number": "xyz789",
+ "returns_enabled": "abc123",
+ "root_category_id": 987,
"root_category_uid": 4,
"sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
- "sales_gift_wrapping": "abc123",
+ "sales_gift_wrapping": "xyz789",
"sales_printed_card": "abc123",
- "secure_base_link_url": "abc123",
- "secure_base_media_url": "xyz789",
- "secure_base_static_url": "xyz789",
- "secure_base_url": "xyz789",
+ "secure_base_link_url": "xyz789",
+ "secure_base_media_url": "abc123",
+ "secure_base_static_url": "abc123",
+ "secure_base_url": "abc123",
"send_friend": SendFriendConfiguration,
- "share_all_catalog_rules": true,
- "share_all_sales_rule": false,
- "share_applied_catalog_rules": true,
- "share_applied_sales_rule": false,
+ "share_active_segments": false,
+ "share_applied_cart_rule": false,
"shopping_cart_display_full_summary": true,
- "shopping_cart_display_grand_total": false,
+ "shopping_cart_display_grand_total": true,
"shopping_cart_display_price": 123,
- "shopping_cart_display_shipping": 987,
- "shopping_cart_display_subtotal": 987,
+ "shopping_cart_display_shipping": 123,
+ "shopping_cart_display_subtotal": 123,
"shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX",
- "shopping_cart_display_zero_tax": true,
+ "shopping_cart_display_zero_tax": false,
"show_cms_breadcrumbs": 987,
- "store_code": "4",
+ "store_code": 4,
"store_group_code": 4,
- "store_group_name": "xyz789",
- "store_name": "abc123",
+ "store_group_name": "abc123",
+ "store_name": "xyz789",
"store_sort_order": 987,
"timezone": "xyz789",
- "title_prefix": "abc123",
- "title_separator": "xyz789",
- "title_suffix": "abc123",
+ "title_prefix": "xyz789",
+ "title_separator": "abc123",
+ "title_suffix": "xyz789",
"use_store_in_url": false,
"website_code": "4",
- "website_id": 123,
+ "website_id": 987,
"website_name": "xyz789",
- "weight_unit": "xyz789",
- "welcome": "abc123",
+ "weight_unit": "abc123",
+ "welcome": "xyz789",
"zero_subtotal_enable_for_specific_countries": true,
"zero_subtotal_enabled": true,
- "zero_subtotal_new_order_status": "xyz789",
- "zero_subtotal_payment_action": "xyz789",
- "zero_subtotal_payment_from_specific_countries": "xyz789",
+ "zero_subtotal_new_order_status": "abc123",
+ "zero_subtotal_payment_action": "abc123",
+ "zero_subtotal_payment_from_specific_countries": "abc123",
"zero_subtotal_sort_order": 987,
- "zero_subtotal_title": "xyz789"
+ "zero_subtotal_title": "abc123"
}
@@ -76700,10 +76558,10 @@ Fields
Example
{
- "position": 987,
+ "position": 123,
"use_in_layered_navigation": "NO",
"use_in_product_listing": false,
- "use_in_search_results_layered_navigation": true,
+ "use_in_search_results_layered_navigation": false,
"visible_on_catalog_pages": true
}
@@ -76727,7 +76585,7 @@ Description
Example
- "abc123"
+ "xyz789"
@@ -76802,7 +76660,7 @@ Example
"comment": "abc123",
"max_order_commitment": 123,
"min_order_commitment": 987,
- "name": "abc123",
+ "name": "xyz789",
"reference_document_links": [
NegotiableQuoteTemplateReferenceDocumentLinkInput
],
@@ -76957,7 +76815,7 @@ Fields
Example
{
"type": "xyz789",
- "value": "xyz789"
+ "value": "abc123"
}
@@ -77237,10 +77095,10 @@ Fields
Example
{
- "items_count": 987,
- "label": "abc123",
+ "items_count": 123,
+ "label": "xyz789",
"swatch_data": SwatchData,
- "value_string": "xyz789"
+ "value_string": "abc123"
}
@@ -77343,7 +77201,7 @@ Fields
Example
{
"cartId": "xyz789",
- "id": "xyz789"
+ "id": "abc123"
}
@@ -77397,7 +77255,7 @@ Example
{
"amount": Money,
"rate": 123.45,
- "title": "xyz789"
+ "title": "abc123"
}
@@ -77595,7 +77453,7 @@ Example
{
"discount": ProductDiscount,
"final_price": Money,
- "quantity": 123.45
+ "quantity": 987.65
}
@@ -77644,7 +77502,7 @@ Fields
Example
{
- "cart_id": "xyz789",
+ "cart_id": "abc123",
"cart_items": [CartItemUpdateInput]
}
@@ -77969,8 +77827,8 @@ Example
"dynamic_attributes": [
GiftRegistryDynamicAttributeInput
],
- "event_name": "xyz789",
- "message": "xyz789",
+ "event_name": "abc123",
+ "message": "abc123",
"privacy_settings": "PRIVATE",
"shipping_address": GiftRegistryShippingAddressInput,
"status": "ACTIVE"
@@ -78028,7 +77886,7 @@ Fields
Example
{
- "gift_registry_item_uid": 4,
+ "gift_registry_item_uid": "4",
"note": "abc123",
"quantity": 123.45
}
@@ -78180,9 +78038,9 @@ Example
"dynamic_attributes": [
GiftRegistryDynamicAttributeInput
],
- "email": "abc123",
+ "email": "xyz789",
"firstname": "xyz789",
- "gift_registry_registrant_uid": "4",
+ "gift_registry_registrant_uid": 4,
"lastname": "xyz789"
}
@@ -78403,7 +78261,7 @@ Fields
Example
{
"items": [NegotiableQuoteTemplateItemQuantityInput],
- "template_id": "4"
+ "template_id": 4
}
@@ -78531,10 +78389,10 @@ Fields
Example
{
"applies_to": ["4"],
- "approvers": [4],
+ "approvers": ["4"],
"condition": CreatePurchaseOrderApprovalRuleConditionInput,
"description": "xyz789",
- "name": "xyz789",
+ "name": "abc123",
"status": "ENABLED",
"uid": 4
}
@@ -78585,7 +78443,7 @@ Fields
Example
{
- "description": "xyz789",
+ "description": "abc123",
"name": "abc123"
}
@@ -78648,8 +78506,8 @@ Fields
Example
{
"entered_options": [EnteredOptionInput],
- "item_id": "4",
- "quantity": 123.45,
+ "item_id": 4,
+ "quantity": 987.65,
"selected_options": ["xyz789"]
}
@@ -78782,7 +78640,7 @@ Fields
Example
{
- "name": "xyz789",
+ "name": "abc123",
"uid": 4,
"visibility": "PUBLIC"
}
@@ -78832,7 +78690,7 @@ Fields
Example
{
"parameters": [HttpQueryParameter],
- "url": "abc123"
+ "url": "xyz789"
}
@@ -79000,7 +78858,7 @@ Fields
Example
{
"currentPage": 987,
- "pageSize": 123,
+ "pageSize": 987,
"sort": [CompaniesSortInput]
}
@@ -79095,7 +78953,7 @@ Fields
Example
- {"message": "xyz789", "type": "NOT_FOUND"}
+ {"message": "abc123", "type": "NOT_FOUND"}
@@ -79297,7 +79155,7 @@ Fields
Example
{
"name": "DATE_RANGE_MAX",
- "value": "xyz789"
+ "value": "abc123"
}
@@ -79549,7 +79407,7 @@ Example
"payment_source": "xyz789",
"payments_order_id": "abc123",
"paypal_order_id": "abc123",
- "public_hash": "xyz789"
+ "public_hash": "abc123"
}
@@ -79743,17 +79601,17 @@ Example
"customizable_options": [SelectedCustomizableOption],
"discount": [Discount],
"errors": [CartItemError],
- "id": "xyz789",
+ "id": "abc123",
"is_available": false,
"max_qty": 987.65,
"min_qty": 123.45,
- "not_available_message": "xyz789",
+ "not_available_message": "abc123",
"note_from_buyer": [ItemNote],
"note_from_seller": [ItemNote],
"prices": CartItemPrices,
"product": ProductInterface,
"quantity": 123.45,
- "uid": 4
+ "uid": "4"
}
@@ -79782,13 +79640,6 @@ Fields
-
- activity - String
-
-
- Use the custom_attributes field instead.
-
-
attribute_set_id - Int
@@ -79805,27 +79656,6 @@ Fields
The categories assigned to a product.
-
- category_gear - String
-
-
- Use the custom_attributes field instead.
-
-
-
- climate - String
-
-
- Use the custom_attributes field instead.
-
-
-
- collar - String
-
-
- Use the custom_attributes field instead.
-
-
color - Int
@@ -79872,41 +79702,6 @@ filters
Detailed information about the product. The value can include simple HTML tags.
-
- eco_collection - Int
-
-
- Use the custom_attributes field instead.
-
-
-
- erin_recommends - Int
-
-
- Use the custom_attributes field instead.
-
-
-
- features_bags - String
-
-
- Use the custom_attributes field instead.
-
-
-
- format - Int
-
-
- Use the custom_attributes field instead.
-
-
-
- gender - String
-
-
- Use the custom_attributes field instead.
-
-
gift_message_available - Boolean!
@@ -79944,13 +79739,6 @@ filters
A number representing the product's manufacturer. Use the custom_attributes field instead.
-
- material - String
-
-
- Use the custom_attributes field instead.
-
-
max_sale_qty - Float
@@ -79992,13 +79780,6 @@ filters
The product name. Customers use this name to identify the product.
-
- new - Int
-
-
- Use the custom_attributes field instead.
-
-
new_from_date - String
@@ -80024,20 +79805,6 @@ filters
If the product has multiple options, determines where they appear on the product page.
-
- pattern - String
-
-
- Use the custom_attributes field instead.
-
-
-
- performance_fabric - Int
-
-
- Use the custom_attributes field instead.
-
-
price - ProductPrices
@@ -80059,13 +79826,6 @@ filters
An array of ProductLinks objects.
-
- purpose - Int
-
-
- Use the custom_attributes field instead.
-
-
quantity - Float
@@ -80120,42 +79880,16 @@ currentPage
-
- rules - [CatalogRule]
-
- Provides applied catalog rules in the current active cart
-
-
- sale - Int
-
-
- Use the custom_attributes field instead.
-
-
short_description - ComplexTextValue
A short description of the product. Its use depends on the theme.
-
- size - Int
-
-
- Use the custom_attributes field instead.
-
-
sku - String
A number or code assigned to a product to identify the product, options, price, and manufacturer.
-
- sleeve - String
-
-
- Use the custom_attributes field instead.
-
-
small_image - ProductImage
@@ -80187,34 +79921,6 @@ currentPage
Stock status of the product
-
- strap_bags - String
-
-
- Use the custom_attributes field instead.
-
-
-
- style_bags - String
-
-
- Use the custom_attributes field instead.
-
-
-
- style_bottom - String
-
-
- Use the custom_attributes field instead.
-
-
-
- style_general - String
-
-
- Use the custom_attributes field instead.
-
-
swatch_image - String
@@ -80300,87 +80006,65 @@ currentPage
Example
{
- "activity": "xyz789",
"attribute_set_id": 987,
- "canonical_url": "xyz789",
+ "canonical_url": "abc123",
"categories": [CategoryInterface],
- "category_gear": "abc123",
- "climate": "xyz789",
- "collar": "xyz789",
"color": 987,
- "country_of_manufacture": "xyz789",
+ "country_of_manufacture": "abc123",
"created_at": "xyz789",
"crosssell_products": [ProductInterface],
"custom_attributesV2": ProductCustomAttributes,
"description": ComplexTextValue,
- "eco_collection": 123,
- "erin_recommends": 123,
- "features_bags": "abc123",
- "format": 987,
- "gender": "abc123",
- "gift_message_available": false,
- "gift_wrapping_available": false,
+ "gift_message_available": true,
+ "gift_wrapping_available": true,
"gift_wrapping_price": Money,
- "id": 987,
+ "id": 123,
"image": ProductImage,
- "is_returnable": "xyz789",
- "manufacturer": 987,
- "material": "abc123",
+ "is_returnable": "abc123",
+ "manufacturer": 123,
"max_sale_qty": 123.45,
"media_gallery": [MediaGalleryInterface],
"media_gallery_entries": [MediaGalleryEntry],
- "meta_description": "abc123",
+ "meta_description": "xyz789",
"meta_keyword": "xyz789",
- "meta_title": "xyz789",
- "min_sale_qty": 123.45,
+ "meta_title": "abc123",
+ "min_sale_qty": 987.65,
"name": "abc123",
- "new": 123,
"new_from_date": "abc123",
"new_to_date": "abc123",
"only_x_left_in_stock": 123.45,
"options": [CustomizableOptionInterface],
"options_container": "abc123",
- "pattern": "abc123",
- "performance_fabric": 987,
"price": ProductPrices,
"price_range": PriceRange,
"price_tiers": [TierPrice],
"product_links": [ProductLinksInterface],
- "purpose": 987,
- "quantity": 987.65,
- "rating_summary": 123.45,
+ "quantity": 123.45,
+ "rating_summary": 987.65,
"redirect_code": 987,
"related_products": [ProductInterface],
- "relative_url": "xyz789",
+ "relative_url": "abc123",
"review_count": 123,
"reviews": ProductReviews,
- "rules": [CatalogRule],
- "sale": 123,
"short_description": ComplexTextValue,
- "size": 987,
- "sku": "xyz789",
- "sleeve": "xyz789",
+ "sku": "abc123",
"small_image": ProductImage,
- "special_from_date": "xyz789",
+ "special_from_date": "abc123",
"special_price": 987.65,
- "special_to_date": "abc123",
- "staged": false,
+ "special_to_date": "xyz789",
+ "staged": true,
"stock_status": "IN_STOCK",
- "strap_bags": "xyz789",
- "style_bags": "abc123",
- "style_bottom": "abc123",
- "style_general": "xyz789",
"swatch_image": "xyz789",
"thumbnail": ProductImage,
- "tier_price": 123.45,
+ "tier_price": 987.65,
"tier_prices": [ProductTierPrices],
"type": "CMS_PAGE",
"type_id": "abc123",
"uid": "4",
"updated_at": "abc123",
"upsell_products": [ProductInterface],
- "url_key": "abc123",
- "url_path": "xyz789",
+ "url_key": "xyz789",
+ "url_path": "abc123",
"url_rewrites": [UrlRewrite],
"url_suffix": "abc123",
"websites": [Website]
@@ -80560,9 +80244,9 @@ Fields
Example
{
- "added_at": "abc123",
+ "added_at": "xyz789",
"customizable_options": [SelectedCustomizableOption],
- "description": "xyz789",
+ "description": "abc123",
"id": 4,
"product": ProductInterface,
"quantity": 987.65
@@ -80638,12 +80322,12 @@ Fields
Example
{
- "code": "xyz789",
- "default_group_id": "abc123",
+ "code": "abc123",
+ "default_group_id": "xyz789",
"id": 987,
"is_default": false,
"name": "xyz789",
- "sort_order": 987
+ "sort_order": 123
}
@@ -80841,8 +80525,8 @@ Example
"items_count": 123,
"items_v2": WishlistItems,
"name": "xyz789",
- "sharing_code": "abc123",
- "updated_at": "abc123",
+ "sharing_code": "xyz789",
+ "updated_at": "xyz789",
"visibility": "PUBLIC"
}
@@ -80903,7 +80587,7 @@ Example
"code": "PRODUCT_NOT_FOUND",
"message": "abc123",
"wishlistId": "4",
- "wishlistItemId": "4"
+ "wishlistItemId": 4
}
@@ -80939,6 +80623,13 @@ Values
+
+
+ REQUIRED_PARAMETER_MISSING
+
+
+
+
NOT_SALABLE
@@ -81029,10 +80720,10 @@ Fields
Example
{
"added_at": "abc123",
- "description": "abc123",
+ "description": "xyz789",
"id": 987,
"product": ProductInterface,
- "qty": 123.45
+ "qty": 987.65
}
@@ -81150,9 +80841,9 @@ Fields
Example
{
"entered_options": [EnteredOptionInput],
- "parent_sku": "abc123",
- "quantity": 123.45,
- "selected_options": ["4"],
+ "parent_sku": "xyz789",
+ "quantity": 987.65,
+ "selected_options": [4],
"sku": "xyz789"
}
@@ -81241,12 +80932,12 @@ Possible Types
-
+
-
+
@@ -81269,10 +80960,10 @@ Example
{
"added_at": "xyz789",
"customizable_options": [SelectedCustomizableOption],
- "description": "abc123",
+ "description": "xyz789",
"id": 4,
"product": ProductInterface,
- "quantity": 123.45
+ "quantity": 987.65
}
@@ -81320,10 +81011,7 @@ Fields
Example
- {
- "quantity": 123.45,
- "wishlist_item_id": "4"
-}
+ {"quantity": 123.45, "wishlist_item_id": 4}
@@ -81389,11 +81077,11 @@ Fields
Example
{
- "description": "abc123",
+ "description": "xyz789",
"entered_options": [EnteredOptionInput],
- "quantity": 987.65,
+ "quantity": 123.45,
"selected_options": [4],
- "wishlist_item_id": 4
+ "wishlist_item_id": "4"
}
@@ -81511,7 +81199,7 @@ Example
"items": [WishlistItem],
"items_count": 123,
"name": "abc123",
- "sharing_code": "xyz789",
+ "sharing_code": "abc123",
"updated_at": "xyz789"
}
@@ -81603,7 +81291,7 @@ Fields
Example
- {"cart_id": "xyz789"}
+ {"cart_id": "abc123"}