Adobe Commerce GraphQL API
The Adobe Commerce GraphQL API allows you to quickly and efficiently transfer information between your Commerce store and your storefront. The schema documented here is autogenerated from an instance of Adobe Commerce with B2B. You can find examples of each query and mutation in the main GraphQL documentation.
API Endpoints
https://<your store>/graphqlHeaders
# Your API token from the dashboard. Must be included in all API calls.
Authorization: Bearer <YOUR_TOKEN_HERE>Version
2.4.7
Queries
attributesForm
Description
Retrieve EAV attributes associated to a frontend form. Use countries query provided by DirectoryGraphQl module to retrieve region_id and country_id attribute options.
Response
Returns an AttributesFormOutput!
Arguments
| Name | Description |
|---|---|
formCode - String!
|
Form code. |
Example
Query
query attributesForm($formCode: String!) {
attributesForm(formCode: $formCode) {
errors {
...AttributeMetadataErrorFragment
}
items {
...CustomAttributeMetadataInterfaceFragment
}
}
}
Variables
{"formCode": "xyz789"}
Response
{
"data": {
"attributesForm": {
"errors": [AttributeMetadataError],
"items": [CustomAttributeMetadataInterface]
}
}
}
attributesList
Description
Returns a list of attributes metadata for a given entity type.
Response
Returns an AttributesMetadataOutput
Arguments
| Name | Description |
|---|---|
entityType - AttributeEntityTypeEnum!
|
Entity type. |
filters - AttributeFilterInput
|
Identifies which filter inputs to search for and return. |
Example
Query
query attributesList(
$entityType: AttributeEntityTypeEnum!,
$filters: AttributeFilterInput
) {
attributesList(
entityType: $entityType,
filters: $filters
) {
errors {
...AttributeMetadataErrorFragment
}
items {
...CustomAttributeMetadataInterfaceFragment
}
}
}
Variables
{
"entityType": "CATALOG_PRODUCT",
"filters": AttributeFilterInput
}
Response
{
"data": {
"attributesList": {
"errors": [AttributeMetadataError],
"items": [CustomAttributeMetadataInterface]
}
}
}
availableStores
Description
Get a list of available store views and their config information.
Response
Returns [StoreConfig]
Arguments
| Name | Description |
|---|---|
useCurrentGroup - Boolean
|
Filter store views by the current store group. |
Example
Query
query availableStores($useCurrentGroup: Boolean) {
availableStores(useCurrentGroup: $useCurrentGroup) {
absolute_footer
allow_gift_receipt
allow_gift_wrapping_on_order
allow_gift_wrapping_on_order_items
allow_guests_to_write_product_reviews
allow_items
allow_order
allow_printed_card
autocomplete_on_storefront
base_currency_code
base_link_url
base_media_url
base_static_url
base_url
braintree_3dsecure_allowspecific
braintree_3dsecure_always_request_3ds
braintree_3dsecure_specificcountry
braintree_3dsecure_threshold_amount
braintree_3dsecure_verify_3dsecure
braintree_ach_direct_debit_vault_active
braintree_applepay_merchant_name
braintree_applepay_vault_active
braintree_cc_vault_active
braintree_cc_vault_cvv
braintree_environment
braintree_googlepay_btn_color
braintree_googlepay_cctypes
braintree_googlepay_merchant_id
braintree_googlepay_vault_active
braintree_local_payment_allowed_methods
braintree_local_payment_fallback_button_text
braintree_local_payment_redirect_on_fail
braintree_merchant_account_id
braintree_paypal_button_location_cart_type_credit_color
braintree_paypal_button_location_cart_type_credit_label
braintree_paypal_button_location_cart_type_credit_shape
braintree_paypal_button_location_cart_type_credit_show
braintree_paypal_button_location_cart_type_messaging_layout
braintree_paypal_button_location_cart_type_messaging_logo
braintree_paypal_button_location_cart_type_messaging_logo_position
braintree_paypal_button_location_cart_type_messaging_show
braintree_paypal_button_location_cart_type_messaging_text_color
braintree_paypal_button_location_cart_type_paylater_color
braintree_paypal_button_location_cart_type_paylater_label
braintree_paypal_button_location_cart_type_paylater_shape
braintree_paypal_button_location_cart_type_paylater_show
braintree_paypal_button_location_cart_type_paypal_color
braintree_paypal_button_location_cart_type_paypal_label
braintree_paypal_button_location_cart_type_paypal_shape
braintree_paypal_button_location_cart_type_paypal_show
braintree_paypal_button_location_checkout_type_credit_color
braintree_paypal_button_location_checkout_type_credit_label
braintree_paypal_button_location_checkout_type_credit_shape
braintree_paypal_button_location_checkout_type_credit_show
braintree_paypal_button_location_checkout_type_messaging_layout
braintree_paypal_button_location_checkout_type_messaging_logo
braintree_paypal_button_location_checkout_type_messaging_logo_position
braintree_paypal_button_location_checkout_type_messaging_show
braintree_paypal_button_location_checkout_type_messaging_text_color
braintree_paypal_button_location_checkout_type_paylater_color
braintree_paypal_button_location_checkout_type_paylater_label
braintree_paypal_button_location_checkout_type_paylater_shape
braintree_paypal_button_location_checkout_type_paylater_show
braintree_paypal_button_location_checkout_type_paypal_color
braintree_paypal_button_location_checkout_type_paypal_label
braintree_paypal_button_location_checkout_type_paypal_shape
braintree_paypal_button_location_checkout_type_paypal_show
braintree_paypal_button_location_productpage_type_credit_color
braintree_paypal_button_location_productpage_type_credit_label
braintree_paypal_button_location_productpage_type_credit_shape
braintree_paypal_button_location_productpage_type_credit_show
braintree_paypal_button_location_productpage_type_messaging_layout
braintree_paypal_button_location_productpage_type_messaging_logo
braintree_paypal_button_location_productpage_type_messaging_logo_position
braintree_paypal_button_location_productpage_type_messaging_show
braintree_paypal_button_location_productpage_type_messaging_text_color
braintree_paypal_button_location_productpage_type_paylater_color
braintree_paypal_button_location_productpage_type_paylater_label
braintree_paypal_button_location_productpage_type_paylater_shape
braintree_paypal_button_location_productpage_type_paylater_show
braintree_paypal_button_location_productpage_type_paypal_color
braintree_paypal_button_location_productpage_type_paypal_label
braintree_paypal_button_location_productpage_type_paypal_shape
braintree_paypal_button_location_productpage_type_paypal_show
braintree_paypal_credit_uk_merchant_name
braintree_paypal_display_on_shopping_cart
braintree_paypal_merchant_country
braintree_paypal_merchant_name_override
braintree_paypal_require_billing_address
braintree_paypal_send_cart_line_items
braintree_paypal_vault_active
cart_expires_in_days
cart_gift_wrapping
cart_printed_card
cart_summary_display_quantity
catalog_default_sort_by
category_fixed_product_tax_display_setting
category_url_suffix
check_money_order_enable_for_specific_countries
check_money_order_enabled
check_money_order_make_check_payable_to
check_money_order_max_order_total
check_money_order_min_order_total
check_money_order_new_order_status
check_money_order_payment_from_specific_countries
check_money_order_send_check_to
check_money_order_sort_order
check_money_order_title
cms_home_page
cms_no_cookies
cms_no_route
code
configurable_thumbnail_source
contact_enabled
copyright
countries_with_required_region
create_account_confirmation
customer_access_token_lifetime
default_country
default_description
default_display_currency_code
default_keywords
default_title
demonotice
display_state_if_optional
enable_multiple_wishlists
front
grid_per_page
grid_per_page_values
head_includes
head_shortcut_icon
header_logo_src
id
is_default_store
is_default_store_group
is_guest_checkout_enabled
is_negotiable_quote_active
is_one_page_checkout_enabled
is_requisition_list_active
list_mode
list_per_page
list_per_page_values
locale
logo_alt
logo_height
logo_width
magento_reward_general_is_enabled
magento_reward_general_is_enabled_on_front
magento_reward_general_min_points_balance
magento_reward_general_publish_history
magento_reward_points_invitation_customer
magento_reward_points_invitation_customer_limit
magento_reward_points_invitation_order
magento_reward_points_invitation_order_limit
magento_reward_points_newsletter
magento_reward_points_order
magento_reward_points_register
magento_reward_points_review
magento_reward_points_review_limit
magento_wishlist_general_is_enabled
max_items_in_order_summary
maximum_number_of_wishlists
minicart_display
minicart_max_items
minimum_password_length
newsletter_enabled
no_route
optional_zip_countries
order_cancellation_enabled
order_cancellation_reasons {
...CancellationReasonFragment
}
payment_payflowpro_cc_vault_active
printed_card_price
product_fixed_product_tax_display_setting
product_reviews_enabled
product_url_suffix
quickorder_active
required_character_classes_number
returns_enabled
root_category_id
root_category_uid
sales_fixed_product_tax_display_setting
sales_gift_wrapping
sales_printed_card
secure_base_link_url
secure_base_media_url
secure_base_static_url
secure_base_url
send_friend {
...SendFriendConfigurationFragment
}
shopping_cart_display_full_summary
shopping_cart_display_grand_total
shopping_cart_display_price
shopping_cart_display_shipping
shopping_cart_display_subtotal
shopping_cart_display_tax_gift_wrapping
shopping_cart_display_zero_tax
show_cms_breadcrumbs
store_code
store_group_code
store_group_name
store_name
store_sort_order
timezone
title_prefix
title_separator
title_suffix
use_store_in_url
website_code
website_id
website_name
weight_unit
welcome
zero_subtotal_enable_for_specific_countries
zero_subtotal_enabled
zero_subtotal_new_order_status
zero_subtotal_payment_action
zero_subtotal_payment_from_specific_countries
zero_subtotal_sort_order
zero_subtotal_title
}
}
Variables
{"useCurrentGroup": false}
Response
{
"data": {
"availableStores": [
{
"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": "abc123",
"allow_items": "abc123",
"allow_order": "abc123",
"allow_printed_card": "xyz789",
"autocomplete_on_storefront": false,
"base_currency_code": "xyz789",
"base_link_url": "xyz789",
"base_media_url": "abc123",
"base_static_url": "abc123",
"base_url": "xyz789",
"braintree_3dsecure_allowspecific": false,
"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": true,
"braintree_applepay_merchant_name": "xyz789",
"braintree_applepay_vault_active": false,
"braintree_cc_vault_active": "xyz789",
"braintree_cc_vault_cvv": true,
"braintree_environment": "abc123",
"braintree_googlepay_btn_color": "xyz789",
"braintree_googlepay_cctypes": "xyz789",
"braintree_googlepay_merchant_id": "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": "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_shape": "abc123",
"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": "xyz789",
"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": "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_show": true,
"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_show": false,
"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_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_text_color": "xyz789",
"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": "abc123",
"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": "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_productpage_type_credit_label": "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": "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": true,
"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_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_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": "abc123",
"braintree_paypal_require_billing_address": false,
"braintree_paypal_send_cart_line_items": false,
"braintree_paypal_vault_active": false,
"cart_expires_in_days": 123,
"cart_gift_wrapping": "abc123",
"cart_printed_card": "abc123",
"cart_summary_display_quantity": 987,
"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": 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_new_order_status": "xyz789",
"check_money_order_payment_from_specific_countries": "xyz789",
"check_money_order_send_check_to": "xyz789",
"check_money_order_sort_order": 987,
"check_money_order_title": "xyz789",
"cms_home_page": "abc123",
"cms_no_cookies": "abc123",
"cms_no_route": "abc123",
"code": "xyz789",
"configurable_thumbnail_source": "xyz789",
"contact_enabled": false,
"copyright": "xyz789",
"countries_with_required_region": "abc123",
"create_account_confirmation": true,
"customer_access_token_lifetime": 123.45,
"default_country": "xyz789",
"default_description": "abc123",
"default_display_currency_code": "xyz789",
"default_keywords": "xyz789",
"default_title": "abc123",
"demonotice": 987,
"display_state_if_optional": false,
"enable_multiple_wishlists": "abc123",
"front": "xyz789",
"grid_per_page": 123,
"grid_per_page_values": "abc123",
"head_includes": "abc123",
"head_shortcut_icon": "abc123",
"header_logo_src": "xyz789",
"id": 987,
"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",
"list_mode": "abc123",
"list_per_page": 987,
"list_per_page_values": "xyz789",
"locale": "xyz789",
"logo_alt": "abc123",
"logo_height": 123,
"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": "abc123",
"magento_reward_points_invitation_customer": "abc123",
"magento_reward_points_invitation_customer_limit": "xyz789",
"magento_reward_points_invitation_order": "xyz789",
"magento_reward_points_invitation_order_limit": "xyz789",
"magento_reward_points_newsletter": "abc123",
"magento_reward_points_order": "abc123",
"magento_reward_points_register": "xyz789",
"magento_reward_points_review": "xyz789",
"magento_reward_points_review_limit": "abc123",
"magento_wishlist_general_is_enabled": "xyz789",
"max_items_in_order_summary": 123,
"maximum_number_of_wishlists": "xyz789",
"minicart_display": false,
"minicart_max_items": 987,
"minimum_password_length": "xyz789",
"newsletter_enabled": false,
"no_route": "abc123",
"optional_zip_countries": "abc123",
"order_cancellation_enabled": false,
"order_cancellation_reasons": [
CancellationReason
],
"payment_payflowpro_cc_vault_active": "xyz789",
"printed_card_price": "xyz789",
"product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
"product_reviews_enabled": "abc123",
"product_url_suffix": "xyz789",
"quickorder_active": true,
"required_character_classes_number": "abc123",
"returns_enabled": "abc123",
"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": "xyz789",
"secure_base_media_url": "xyz789",
"secure_base_static_url": "abc123",
"secure_base_url": "xyz789",
"send_friend": SendFriendConfiguration,
"shopping_cart_display_full_summary": false,
"shopping_cart_display_grand_total": false,
"shopping_cart_display_price": 987,
"shopping_cart_display_shipping": 987,
"shopping_cart_display_subtotal": 123,
"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_name": "abc123",
"store_name": "abc123",
"store_sort_order": 987,
"timezone": "xyz789",
"title_prefix": "abc123",
"title_separator": "xyz789",
"title_suffix": "xyz789",
"use_store_in_url": true,
"website_code": "4",
"website_id": 987,
"website_name": "abc123",
"weight_unit": "abc123",
"welcome": "xyz789",
"zero_subtotal_enable_for_specific_countries": true,
"zero_subtotal_enabled": true,
"zero_subtotal_new_order_status": "abc123",
"zero_subtotal_payment_action": "abc123",
"zero_subtotal_payment_from_specific_countries": "xyz789",
"zero_subtotal_sort_order": 123,
"zero_subtotal_title": "abc123"
}
]
}
}
cart
Description
Return information about the specified shopping cart.
Response
Returns a Cart
Arguments
| Name | Description |
|---|---|
cart_id - String!
|
The unique ID of the cart to query. |
Example
Query
query cart($cart_id: String!) {
cart(cart_id: $cart_id) {
applied_coupon {
...AppliedCouponFragment
}
applied_coupons {
...AppliedCouponFragment
}
applied_gift_cards {
...AppliedGiftCardFragment
}
applied_reward_points {
...RewardPointsAmountFragment
}
applied_store_credit {
...AppliedStoreCreditFragment
}
available_gift_wrappings {
...GiftWrappingFragment
}
available_payment_methods {
...AvailablePaymentMethodFragment
}
billing_address {
...BillingCartAddressFragment
}
email
gift_message {
...GiftMessageFragment
}
gift_receipt_included
gift_wrapping {
...GiftWrappingFragment
}
id
is_virtual
items {
...CartItemInterfaceFragment
}
itemsV2 {
...CartItemsFragment
}
prices {
...CartPricesFragment
}
printed_card_included
selected_payment_method {
...SelectedPaymentMethodFragment
}
shipping_addresses {
...ShippingCartAddressFragment
}
total_quantity
}
}
Variables
{"cart_id": "abc123"}
Response
{
"data": {
"cart": {
"applied_coupon": AppliedCoupon,
"applied_coupons": [AppliedCoupon],
"applied_gift_cards": [AppliedGiftCard],
"applied_reward_points": RewardPointsAmount,
"applied_store_credit": AppliedStoreCredit,
"available_gift_wrappings": [GiftWrapping],
"available_payment_methods": [
AvailablePaymentMethod
],
"billing_address": BillingCartAddress,
"email": "abc123",
"gift_message": GiftMessage,
"gift_receipt_included": false,
"gift_wrapping": GiftWrapping,
"id": "4",
"is_virtual": false,
"items": [CartItemInterface],
"itemsV2": CartItems,
"prices": CartPrices,
"printed_card_included": false,
"selected_payment_method": SelectedPaymentMethod,
"shipping_addresses": [ShippingCartAddress],
"total_quantity": 987.65
}
}
}
categories
Description
Return a list of categories that match the specified filter.
Response
Returns a CategoryResult
Arguments
| Name | Description |
|---|---|
filters - CategoryFilterInput
|
Identifies which Category filter inputs to search for and return. |
pageSize - Int
|
Specifies the maximum number of results to return at once. The default value is 20. Default = 20 |
currentPage - Int
|
Specifies which page of results to return. The default value is 1. Default = 1 |
Example
Query
query categories(
$filters: CategoryFilterInput,
$pageSize: Int,
$currentPage: Int
) {
categories(
filters: $filters,
pageSize: $pageSize,
currentPage: $currentPage
) {
items {
...CategoryTreeFragment
}
page_info {
...SearchResultPageInfoFragment
}
total_count
}
}
Variables
{
"filters": CategoryFilterInput,
"pageSize": 20,
"currentPage": 1
}
Response
{
"data": {
"categories": {
"items": [CategoryTree],
"page_info": SearchResultPageInfo,
"total_count": 123
}
}
}
category
Use
categories instead. Description
Search for categories that match the criteria specified in the search and filter attributes.
Response
Returns a CategoryTree
Arguments
| Name | Description |
|---|---|
id - Int
|
The category ID to use as the root of the search. |
Example
Query
query category($id: Int) {
category(id: $id) {
automatic_sorting
available_sort_by
breadcrumbs {
...BreadcrumbFragment
}
canonical_url
children {
...CategoryTreeFragment
}
children_count
cms_block {
...CmsBlockFragment
}
created_at
custom_layout_update_file
default_sort_by
description
display_mode
filter_price_range
id
image
include_in_menu
is_anchor
landing_page
level
meta_description
meta_keywords
meta_title
name
path
path_in_store
position
product_count
products {
...CategoryProductsFragment
}
redirect_code
relative_url
staged
type
uid
updated_at
url_key
url_path
url_suffix
}
}
Variables
{"id": 123}
Response
{
"data": {
"category": {
"automatic_sorting": "abc123",
"available_sort_by": ["xyz789"],
"breadcrumbs": [Breadcrumb],
"canonical_url": "xyz789",
"children": [CategoryTree],
"children_count": "abc123",
"cms_block": CmsBlock,
"created_at": "xyz789",
"custom_layout_update_file": "xyz789",
"default_sort_by": "xyz789",
"description": "xyz789",
"display_mode": "abc123",
"filter_price_range": 987.65,
"id": 987,
"image": "xyz789",
"include_in_menu": 987,
"is_anchor": 123,
"landing_page": 987,
"level": 123,
"meta_description": "xyz789",
"meta_keywords": "abc123",
"meta_title": "abc123",
"name": "abc123",
"path": "abc123",
"path_in_store": "xyz789",
"position": 987,
"product_count": 987,
"products": CategoryProducts,
"redirect_code": 123,
"relative_url": "abc123",
"staged": false,
"type": "CMS_PAGE",
"uid": 4,
"updated_at": "xyz789",
"url_key": "xyz789",
"url_path": "xyz789",
"url_suffix": "xyz789"
}
}
}
categoryList
Use
categories instead. Description
Return an array of categories based on the specified filters.
Response
Returns [CategoryTree]
Arguments
| Name | Description |
|---|---|
filters - CategoryFilterInput
|
Identifies which Category filter inputs to search for and return. |
pageSize - Int
|
Specifies the maximum number of results to return at once. The default value is 20. Default = 20 |
currentPage - Int
|
Specifies which page of results to return. The default value is 1. Default = 1 |
Example
Query
query categoryList(
$filters: CategoryFilterInput,
$pageSize: Int,
$currentPage: Int
) {
categoryList(
filters: $filters,
pageSize: $pageSize,
currentPage: $currentPage
) {
automatic_sorting
available_sort_by
breadcrumbs {
...BreadcrumbFragment
}
canonical_url
children {
...CategoryTreeFragment
}
children_count
cms_block {
...CmsBlockFragment
}
created_at
custom_layout_update_file
default_sort_by
description
display_mode
filter_price_range
id
image
include_in_menu
is_anchor
landing_page
level
meta_description
meta_keywords
meta_title
name
path
path_in_store
position
product_count
products {
...CategoryProductsFragment
}
redirect_code
relative_url
staged
type
uid
updated_at
url_key
url_path
url_suffix
}
}
Variables
{
"filters": CategoryFilterInput,
"pageSize": 20,
"currentPage": 1
}
Response
{
"data": {
"categoryList": [
{
"automatic_sorting": "abc123",
"available_sort_by": ["xyz789"],
"breadcrumbs": [Breadcrumb],
"canonical_url": "xyz789",
"children": [CategoryTree],
"children_count": "xyz789",
"cms_block": CmsBlock,
"created_at": "abc123",
"custom_layout_update_file": "xyz789",
"default_sort_by": "abc123",
"description": "abc123",
"display_mode": "abc123",
"filter_price_range": 123.45,
"id": 123,
"image": "abc123",
"include_in_menu": 123,
"is_anchor": 987,
"landing_page": 987,
"level": 987,
"meta_description": "abc123",
"meta_keywords": "abc123",
"meta_title": "abc123",
"name": "xyz789",
"path": "xyz789",
"path_in_store": "abc123",
"position": 123,
"product_count": 987,
"products": CategoryProducts,
"redirect_code": 123,
"relative_url": "xyz789",
"staged": true,
"type": "CMS_PAGE",
"uid": 4,
"updated_at": "xyz789",
"url_key": "xyz789",
"url_path": "abc123",
"url_suffix": "abc123"
}
]
}
}
checkoutAgreements
Description
Return Terms and Conditions configuration information.
Response
Returns [CheckoutAgreement]
Example
Query
query checkoutAgreements {
checkoutAgreements {
agreement_id
checkbox_text
content
content_height
is_html
mode
name
}
}
Response
{
"data": {
"checkoutAgreements": [
{
"agreement_id": 987,
"checkbox_text": "xyz789",
"content": "xyz789",
"content_height": "xyz789",
"is_html": true,
"mode": "AUTO",
"name": "abc123"
}
]
}
}
cmsBlocks
Description
Return information about CMS blocks.
Response
Returns a CmsBlocks
Arguments
| Name | Description |
|---|---|
identifiers - [String]
|
An array of CMS block IDs. |
Example
Query
query cmsBlocks($identifiers: [String]) {
cmsBlocks(identifiers: $identifiers) {
items {
...CmsBlockFragment
}
}
}
Variables
{"identifiers": ["abc123"]}
Response
{"data": {"cmsBlocks": {"items": [CmsBlock]}}}
cmsPage
Description
Return details about a CMS page.
Response
Returns a CmsPage
Example
Query
query cmsPage(
$id: Int,
$identifier: String
) {
cmsPage(
id: $id,
identifier: $identifier
) {
content
content_heading
identifier
meta_description
meta_keywords
meta_title
page_layout
redirect_code
relative_url
title
type
url_key
}
}
Variables
{"id": 987, "identifier": "abc123"}
Response
{
"data": {
"cmsPage": {
"content": "xyz789",
"content_heading": "xyz789",
"identifier": "abc123",
"meta_description": "xyz789",
"meta_keywords": "abc123",
"meta_title": "abc123",
"page_layout": "xyz789",
"redirect_code": 987,
"relative_url": "xyz789",
"title": "abc123",
"type": "CMS_PAGE",
"url_key": "abc123"
}
}
}
company
Description
Return detailed information about the authenticated customer's company.
Response
Returns a Company
Example
Query
query company {
company {
acl_resources {
...CompanyAclResourceFragment
}
company_admin {
...CustomerFragment
}
credit {
...CompanyCreditFragment
}
credit_history {
...CompanyCreditHistoryFragment
}
email
id
legal_address {
...CompanyLegalAddressFragment
}
legal_name
name
payment_methods
reseller_id
role {
...CompanyRoleFragment
}
roles {
...CompanyRolesFragment
}
sales_representative {
...CompanySalesRepresentativeFragment
}
structure {
...CompanyStructureFragment
}
team {
...CompanyTeamFragment
}
user {
...CustomerFragment
}
users {
...CompanyUsersFragment
}
vat_tax_id
}
}
Response
{
"data": {
"company": {
"acl_resources": [CompanyAclResource],
"company_admin": Customer,
"credit": CompanyCredit,
"credit_history": CompanyCreditHistory,
"email": "abc123",
"id": "4",
"legal_address": CompanyLegalAddress,
"legal_name": "abc123",
"name": "xyz789",
"payment_methods": ["abc123"],
"reseller_id": "xyz789",
"role": CompanyRole,
"roles": CompanyRoles,
"sales_representative": CompanySalesRepresentative,
"structure": CompanyStructure,
"team": CompanyTeam,
"user": Customer,
"users": CompanyUsers,
"vat_tax_id": "xyz789"
}
}
}
compareList
Description
Return products that have been added to the specified compare list.
Response
Returns a CompareList
Arguments
| Name | Description |
|---|---|
uid - ID!
|
The unique ID of the compare list to be queried. |
Example
Query
query compareList($uid: ID!) {
compareList(uid: $uid) {
attributes {
...ComparableAttributeFragment
}
item_count
items {
...ComparableItemFragment
}
uid
}
}
Variables
{"uid": 4}
Response
{
"data": {
"compareList": {
"attributes": [ComparableAttribute],
"item_count": 123,
"items": [ComparableItem],
"uid": "4"
}
}
}
countries
Description
The countries query provides information for all countries.
Response
Returns [Country]
Example
Query
query countries {
countries {
available_regions {
...RegionFragment
}
full_name_english
full_name_locale
id
three_letter_abbreviation
two_letter_abbreviation
}
}
Response
{
"data": {
"countries": [
{
"available_regions": [Region],
"full_name_english": "abc123",
"full_name_locale": "abc123",
"id": "abc123",
"three_letter_abbreviation": "xyz789",
"two_letter_abbreviation": "abc123"
}
]
}
}
country
Description
The countries query provides information for a single country.
Example
Query
query country($id: String) {
country(id: $id) {
available_regions {
...RegionFragment
}
full_name_english
full_name_locale
id
three_letter_abbreviation
two_letter_abbreviation
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"country": {
"available_regions": [Region],
"full_name_english": "abc123",
"full_name_locale": "abc123",
"id": "xyz789",
"three_letter_abbreviation": "abc123",
"two_letter_abbreviation": "abc123"
}
}
}
currency
Description
Return information about the store's currency.
Response
Returns a Currency
Example
Query
query currency {
currency {
available_currency_codes
base_currency_code
base_currency_symbol
default_display_currecy_code
default_display_currecy_symbol
default_display_currency_code
default_display_currency_symbol
exchange_rates {
...ExchangeRateFragment
}
}
}
Response
{
"data": {
"currency": {
"available_currency_codes": [
"abc123"
],
"base_currency_code": "abc123",
"base_currency_symbol": "xyz789",
"default_display_currecy_code": "abc123",
"default_display_currecy_symbol": "abc123",
"default_display_currency_code": "xyz789",
"default_display_currency_symbol": "abc123",
"exchange_rates": [ExchangeRate]
}
}
}
customAttributeMetadata
Use
customAttributeMetadataV2 query instead. Description
Return the attribute type, given an attribute code and entity type.
Response
Returns a CustomAttributeMetadata
Arguments
| Name | Description |
|---|---|
attributes - [AttributeInput!]!
|
An input object that specifies the attribute code and entity type to search. |
Example
Query
query customAttributeMetadata($attributes: [AttributeInput!]!) {
customAttributeMetadata(attributes: $attributes) {
items {
...AttributeFragment
}
}
}
Variables
{"attributes": [AttributeInput]}
Response
{
"data": {
"customAttributeMetadata": {"items": [Attribute]}
}
}
customAttributeMetadataV2
Description
Retrieve EAV attributes metadata.
Response
Returns an AttributesMetadataOutput!
Arguments
| Name | Description |
|---|---|
attributes - [AttributeInput!]
|
Example
Query
query customAttributeMetadataV2($attributes: [AttributeInput!]) {
customAttributeMetadataV2(attributes: $attributes) {
errors {
...AttributeMetadataErrorFragment
}
items {
...CustomAttributeMetadataInterfaceFragment
}
}
}
Variables
{"attributes": [AttributeInput]}
Response
{
"data": {
"customAttributeMetadataV2": {
"errors": [AttributeMetadataError],
"items": [CustomAttributeMetadataInterface]
}
}
}
customer
Description
Return detailed information about a customer account.
Response
Returns a Customer
Example
Query
query customer {
customer {
addresses {
...CustomerAddressFragment
}
allow_remote_shopping_assistance
compare_list {
...CompareListFragment
}
confirmation_status
created_at
custom_attributes {
...AttributeValueInterfaceFragment
}
date_of_birth
default_billing
default_shipping
dob
email
firstname
gender
gift_registries {
...GiftRegistryFragment
}
gift_registry {
...GiftRegistryFragment
}
group_id
id
is_subscribed
job_title
lastname
middlename
orders {
...CustomerOrdersFragment
}
prefix
purchase_order {
...PurchaseOrderFragment
}
purchase_order_approval_rule {
...PurchaseOrderApprovalRuleFragment
}
purchase_order_approval_rule_metadata {
...PurchaseOrderApprovalRuleMetadataFragment
}
purchase_order_approval_rules {
...PurchaseOrderApprovalRulesFragment
}
purchase_orders {
...PurchaseOrdersFragment
}
purchase_orders_enabled
requisition_lists {
...RequisitionListsFragment
}
return {
...ReturnFragment
}
returns {
...ReturnsFragment
}
reviews {
...ProductReviewsFragment
}
reward_points {
...RewardPointsFragment
}
role {
...CompanyRoleFragment
}
status
store_credit {
...CustomerStoreCreditFragment
}
structure_id
suffix
taxvat
team {
...CompanyTeamFragment
}
telephone
wishlist {
...WishlistFragment
}
wishlist_v2 {
...WishlistFragment
}
wishlists {
...WishlistFragment
}
}
}
Response
{
"data": {
"customer": {
"addresses": [CustomerAddress],
"allow_remote_shopping_assistance": true,
"compare_list": CompareList,
"confirmation_status": "ACCOUNT_CONFIRMED",
"created_at": "xyz789",
"custom_attributes": [AttributeValueInterface],
"date_of_birth": "abc123",
"default_billing": "xyz789",
"default_shipping": "abc123",
"dob": "xyz789",
"email": "abc123",
"firstname": "xyz789",
"gender": 987,
"gift_registries": [GiftRegistry],
"gift_registry": GiftRegistry,
"group_id": 987,
"id": 987,
"is_subscribed": false,
"job_title": "abc123",
"lastname": "xyz789",
"middlename": "abc123",
"orders": CustomerOrders,
"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": false,
"requisition_lists": RequisitionLists,
"return": Return,
"returns": Returns,
"reviews": ProductReviews,
"reward_points": RewardPoints,
"role": CompanyRole,
"status": "ACTIVE",
"store_credit": CustomerStoreCredit,
"structure_id": "4",
"suffix": "abc123",
"taxvat": "abc123",
"team": CompanyTeam,
"telephone": "xyz789",
"wishlist": Wishlist,
"wishlist_v2": Wishlist,
"wishlists": [Wishlist]
}
}
}
customerCart
Description
Return information about the customer's shopping cart.
Response
Returns a Cart!
Example
Query
query customerCart {
customerCart {
applied_coupon {
...AppliedCouponFragment
}
applied_coupons {
...AppliedCouponFragment
}
applied_gift_cards {
...AppliedGiftCardFragment
}
applied_reward_points {
...RewardPointsAmountFragment
}
applied_store_credit {
...AppliedStoreCreditFragment
}
available_gift_wrappings {
...GiftWrappingFragment
}
available_payment_methods {
...AvailablePaymentMethodFragment
}
billing_address {
...BillingCartAddressFragment
}
email
gift_message {
...GiftMessageFragment
}
gift_receipt_included
gift_wrapping {
...GiftWrappingFragment
}
id
is_virtual
items {
...CartItemInterfaceFragment
}
itemsV2 {
...CartItemsFragment
}
prices {
...CartPricesFragment
}
printed_card_included
selected_payment_method {
...SelectedPaymentMethodFragment
}
shipping_addresses {
...ShippingCartAddressFragment
}
total_quantity
}
}
Response
{
"data": {
"customerCart": {
"applied_coupon": AppliedCoupon,
"applied_coupons": [AppliedCoupon],
"applied_gift_cards": [AppliedGiftCard],
"applied_reward_points": RewardPointsAmount,
"applied_store_credit": AppliedStoreCredit,
"available_gift_wrappings": [GiftWrapping],
"available_payment_methods": [
AvailablePaymentMethod
],
"billing_address": BillingCartAddress,
"email": "abc123",
"gift_message": GiftMessage,
"gift_receipt_included": false,
"gift_wrapping": GiftWrapping,
"id": 4,
"is_virtual": false,
"items": [CartItemInterface],
"itemsV2": CartItems,
"prices": CartPrices,
"printed_card_included": false,
"selected_payment_method": SelectedPaymentMethod,
"shipping_addresses": [ShippingCartAddress],
"total_quantity": 123.45
}
}
}
customerDownloadableProducts
Description
Return a list of downloadable products the customer has purchased.
Response
Returns a CustomerDownloadableProducts
Example
Query
query customerDownloadableProducts {
customerDownloadableProducts {
items {
...CustomerDownloadableProductFragment
}
}
}
Response
{
"data": {
"customerDownloadableProducts": {
"items": [CustomerDownloadableProduct]
}
}
}
customerOrders
Use the
customer query instead. Response
Returns a CustomerOrders
Example
Query
query customerOrders {
customerOrders {
items {
...CustomerOrderFragment
}
page_info {
...SearchResultPageInfoFragment
}
total_count
}
}
Response
{
"data": {
"customerOrders": {
"items": [CustomerOrder],
"page_info": SearchResultPageInfo,
"total_count": 123
}
}
}
customerPaymentTokens
Description
Return a list of customer payment tokens stored in the vault.
Response
Returns a CustomerPaymentTokens
Example
Query
query customerPaymentTokens {
customerPaymentTokens {
items {
...PaymentTokenFragment
}
}
}
Response
{
"data": {
"customerPaymentTokens": {"items": [PaymentToken]}
}
}
dynamicBlocks
Description
Return a list of dynamic blocks filtered by type, location, or UIDs.
Response
Returns a DynamicBlocks!
Arguments
| Name | Description |
|---|---|
input - DynamicBlocksFilterInput
|
Defines the filter for returning matching dynamic blocks. |
pageSize - Int
|
The maximum number of results to return at once. The default is 20. Default = 20 |
currentPage - Int
|
The page of results to return. The default is 1. Default = 1 |
Example
Query
query dynamicBlocks(
$input: DynamicBlocksFilterInput,
$pageSize: Int,
$currentPage: Int
) {
dynamicBlocks(
input: $input,
pageSize: $pageSize,
currentPage: $currentPage
) {
items {
...DynamicBlockFragment
}
page_info {
...SearchResultPageInfoFragment
}
total_count
}
}
Variables
{
"input": DynamicBlocksFilterInput,
"pageSize": 20,
"currentPage": 1
}
Response
{
"data": {
"dynamicBlocks": {
"items": [DynamicBlock],
"page_info": SearchResultPageInfo,
"total_count": 123
}
}
}
getHostedProUrl
Description
Retrieve the secure PayPal URL for a Payments Pro Hosted Solution transaction.
Response
Returns a HostedProUrl
Arguments
| Name | Description |
|---|---|
input - HostedProUrlInput!
|
An input object that specifies the cart ID. |
Example
Query
query getHostedProUrl($input: HostedProUrlInput!) {
getHostedProUrl(input: $input) {
secure_form_url
}
}
Variables
{"input": HostedProUrlInput}
Response
{
"data": {
"getHostedProUrl": {
"secure_form_url": "abc123"
}
}
}
getPayflowLinkToken
Description
Retrieve payment credentials for a transaction. Use this query for Payflow Link and Payments Advanced payment methods.
Response
Returns a PayflowLinkToken
Arguments
| Name | Description |
|---|---|
input - PayflowLinkTokenInput!
|
An input object that defines the requirements to receive a payment token. |
Example
Query
query getPayflowLinkToken($input: PayflowLinkTokenInput!) {
getPayflowLinkToken(input: $input) {
mode
paypal_url
secure_token
secure_token_id
}
}
Variables
{"input": PayflowLinkTokenInput}
Response
{
"data": {
"getPayflowLinkToken": {
"mode": "TEST",
"paypal_url": "abc123",
"secure_token": "xyz789",
"secure_token_id": "abc123"
}
}
}
getPaymentConfig
Description
Retrieves the payment configuration for a given location
Response
Returns a PaymentConfigOutput
Arguments
| Name | Description |
|---|---|
location - PaymentLocation!
|
Defines the origin location for that payment request |
Example
Query
query getPaymentConfig($location: PaymentLocation!) {
getPaymentConfig(location: $location) {
apple_pay {
...ApplePayConfigFragment
}
hosted_fields {
...HostedFieldsConfigFragment
}
smart_buttons {
...SmartButtonsConfigFragment
}
}
}
Variables
{"location": "PRODUCT_DETAIL"}
Response
{
"data": {
"getPaymentConfig": {
"apple_pay": ApplePayConfig,
"hosted_fields": HostedFieldsConfig,
"smart_buttons": SmartButtonsConfig
}
}
}
getPaymentOrder
Description
Retrieves the payment details for the order
Response
Returns a PaymentOrderOutput
Example
Query
query getPaymentOrder(
$cartId: String!,
$id: String!
) {
getPaymentOrder(
cartId: $cartId,
id: $id
) {
id
mp_order_id
payment_source_details {
...PaymentSourceDetailsFragment
}
status
}
}
Variables
{
"cartId": "xyz789",
"id": "abc123"
}
Response
{
"data": {
"getPaymentOrder": {
"id": "abc123",
"mp_order_id": "xyz789",
"payment_source_details": PaymentSourceDetails,
"status": "abc123"
}
}
}
getPaymentSDK
Description
Gets the payment SDK urls and values
Response
Returns an GetPaymentSDKOutput
Arguments
| Name | Description |
|---|---|
location - PaymentLocation!
|
Defines the origin location for that payment request |
Example
Query
query getPaymentSDK($location: PaymentLocation!) {
getPaymentSDK(location: $location) {
sdkParams {
...PaymentSDKParamsItemFragment
}
}
}
Variables
{"location": "PRODUCT_DETAIL"}
Response
{
"data": {
"getPaymentSDK": {"sdkParams": [PaymentSDKParamsItem]}
}
}
giftCardAccount
Description
Return details about a specific gift card.
Response
Returns a GiftCardAccount
Arguments
| Name | Description |
|---|---|
input - GiftCardAccountInput!
|
An input object that specifies the gift card code. |
Example
Query
query giftCardAccount($input: GiftCardAccountInput!) {
giftCardAccount(input: $input) {
balance {
...MoneyFragment
}
code
expiration_date
}
}
Variables
{"input": GiftCardAccountInput}
Response
{
"data": {
"giftCardAccount": {
"balance": Money,
"code": "abc123",
"expiration_date": "xyz789"
}
}
}
giftRegistry
Description
Return the specified gift registry. Some details will not be available to guests.
Response
Returns a GiftRegistry
Arguments
| Name | Description |
|---|---|
giftRegistryUid - ID!
|
The unique ID of the registry to search for. |
Example
Query
query giftRegistry($giftRegistryUid: ID!) {
giftRegistry(giftRegistryUid: $giftRegistryUid) {
created_at
dynamic_attributes {
...GiftRegistryDynamicAttributeFragment
}
event_name
items {
...GiftRegistryItemInterfaceFragment
}
message
owner_name
privacy_settings
registrants {
...GiftRegistryRegistrantFragment
}
shipping_address {
...CustomerAddressFragment
}
status
type {
...GiftRegistryTypeFragment
}
uid
}
}
Variables
{"giftRegistryUid": 4}
Response
{
"data": {
"giftRegistry": {
"created_at": "xyz789",
"dynamic_attributes": [
GiftRegistryDynamicAttribute
],
"event_name": "xyz789",
"items": [GiftRegistryItemInterface],
"message": "abc123",
"owner_name": "abc123",
"privacy_settings": "PRIVATE",
"registrants": [GiftRegistryRegistrant],
"shipping_address": CustomerAddress,
"status": "ACTIVE",
"type": GiftRegistryType,
"uid": "4"
}
}
}
giftRegistryEmailSearch
Description
Search for gift registries by specifying a registrant email address.
Response
Returns [GiftRegistrySearchResult]
Arguments
| Name | Description |
|---|---|
email - String!
|
The registrant's email. |
Example
Query
query giftRegistryEmailSearch($email: String!) {
giftRegistryEmailSearch(email: $email) {
event_date
event_title
gift_registry_uid
location
name
type
}
}
Variables
{"email": "xyz789"}
Response
{
"data": {
"giftRegistryEmailSearch": [
{
"event_date": "xyz789",
"event_title": "abc123",
"gift_registry_uid": 4,
"location": "xyz789",
"name": "xyz789",
"type": "abc123"
}
]
}
}
giftRegistryIdSearch
Description
Search for gift registries by specifying a registry URL key.
Response
Returns [GiftRegistrySearchResult]
Arguments
| Name | Description |
|---|---|
giftRegistryUid - ID!
|
The unique ID of the gift registry. |
Example
Query
query giftRegistryIdSearch($giftRegistryUid: ID!) {
giftRegistryIdSearch(giftRegistryUid: $giftRegistryUid) {
event_date
event_title
gift_registry_uid
location
name
type
}
}
Variables
{"giftRegistryUid": 4}
Response
{
"data": {
"giftRegistryIdSearch": [
{
"event_date": "xyz789",
"event_title": "xyz789",
"gift_registry_uid": 4,
"location": "xyz789",
"name": "abc123",
"type": "xyz789"
}
]
}
}
giftRegistryTypeSearch
Description
Search for gift registries by specifying the registrant name and registry type ID.
Response
Returns [GiftRegistrySearchResult]
Example
Query
query giftRegistryTypeSearch(
$firstName: String!,
$lastName: String!,
$giftRegistryTypeUid: ID
) {
giftRegistryTypeSearch(
firstName: $firstName,
lastName: $lastName,
giftRegistryTypeUid: $giftRegistryTypeUid
) {
event_date
event_title
gift_registry_uid
location
name
type
}
}
Variables
{
"firstName": "abc123",
"lastName": "xyz789",
"giftRegistryTypeUid": 4
}
Response
{
"data": {
"giftRegistryTypeSearch": [
{
"event_date": "xyz789",
"event_title": "abc123",
"gift_registry_uid": 4,
"location": "abc123",
"name": "abc123",
"type": "abc123"
}
]
}
}
giftRegistryTypes
Description
Get a list of available gift registry types.
Response
Returns [GiftRegistryType]
Example
Query
query giftRegistryTypes {
giftRegistryTypes {
dynamic_attributes_metadata {
...GiftRegistryDynamicAttributeMetadataInterfaceFragment
}
label
uid
}
}
Response
{
"data": {
"giftRegistryTypes": [
{
"dynamic_attributes_metadata": [
GiftRegistryDynamicAttributeMetadataInterface
],
"label": "abc123",
"uid": 4
}
]
}
}
guestOrder
Description
Retrieve guest order details based on number, email and postcode.
Response
Returns a CustomerOrder!
Arguments
| Name | Description |
|---|---|
input - OrderInformationInput!
|
Example
Query
query guestOrder($input: OrderInformationInput!) {
guestOrder(input: $input) {
applied_coupons {
...AppliedCouponFragment
}
billing_address {
...OrderAddressFragment
}
carrier
comments {
...SalesCommentItemFragment
}
created_at
credit_memos {
...CreditMemoFragment
}
email
gift_message {
...GiftMessageFragment
}
gift_receipt_included
gift_wrapping {
...GiftWrappingFragment
}
grand_total
id
increment_id
invoices {
...InvoiceFragment
}
items {
...OrderItemInterfaceFragment
}
items_eligible_for_return {
...OrderItemInterfaceFragment
}
number
order_date
order_number
payment_methods {
...OrderPaymentMethodFragment
}
printed_card_included
returns {
...ReturnsFragment
}
shipments {
...OrderShipmentFragment
}
shipping_address {
...OrderAddressFragment
}
shipping_method
status
token
total {
...OrderTotalFragment
}
}
}
Variables
{"input": OrderInformationInput}
Response
{
"data": {
"guestOrder": {
"applied_coupons": [AppliedCoupon],
"billing_address": OrderAddress,
"carrier": "xyz789",
"comments": [SalesCommentItem],
"created_at": "abc123",
"credit_memos": [CreditMemo],
"email": "xyz789",
"gift_message": GiftMessage,
"gift_receipt_included": true,
"gift_wrapping": GiftWrapping,
"grand_total": 987.65,
"id": 4,
"increment_id": "abc123",
"invoices": [Invoice],
"items": [OrderItemInterface],
"items_eligible_for_return": [OrderItemInterface],
"number": "abc123",
"order_date": "xyz789",
"order_number": "abc123",
"payment_methods": [OrderPaymentMethod],
"printed_card_included": true,
"returns": Returns,
"shipments": [OrderShipment],
"shipping_address": OrderAddress,
"shipping_method": "xyz789",
"status": "abc123",
"token": "xyz789",
"total": OrderTotal
}
}
}
guestOrderByToken
Description
Retrieve guest order details based on token.
Response
Returns a CustomerOrder!
Arguments
| Name | Description |
|---|---|
input - OrderTokenInput!
|
Example
Query
query guestOrderByToken($input: OrderTokenInput!) {
guestOrderByToken(input: $input) {
applied_coupons {
...AppliedCouponFragment
}
billing_address {
...OrderAddressFragment
}
carrier
comments {
...SalesCommentItemFragment
}
created_at
credit_memos {
...CreditMemoFragment
}
email
gift_message {
...GiftMessageFragment
}
gift_receipt_included
gift_wrapping {
...GiftWrappingFragment
}
grand_total
id
increment_id
invoices {
...InvoiceFragment
}
items {
...OrderItemInterfaceFragment
}
items_eligible_for_return {
...OrderItemInterfaceFragment
}
number
order_date
order_number
payment_methods {
...OrderPaymentMethodFragment
}
printed_card_included
returns {
...ReturnsFragment
}
shipments {
...OrderShipmentFragment
}
shipping_address {
...OrderAddressFragment
}
shipping_method
status
token
total {
...OrderTotalFragment
}
}
}
Variables
{"input": OrderTokenInput}
Response
{
"data": {
"guestOrderByToken": {
"applied_coupons": [AppliedCoupon],
"billing_address": OrderAddress,
"carrier": "xyz789",
"comments": [SalesCommentItem],
"created_at": "xyz789",
"credit_memos": [CreditMemo],
"email": "abc123",
"gift_message": GiftMessage,
"gift_receipt_included": true,
"gift_wrapping": GiftWrapping,
"grand_total": 123.45,
"id": "4",
"increment_id": "abc123",
"invoices": [Invoice],
"items": [OrderItemInterface],
"items_eligible_for_return": [OrderItemInterface],
"number": "xyz789",
"order_date": "abc123",
"order_number": "xyz789",
"payment_methods": [OrderPaymentMethod],
"printed_card_included": true,
"returns": Returns,
"shipments": [OrderShipment],
"shipping_address": OrderAddress,
"shipping_method": "xyz789",
"status": "abc123",
"token": "xyz789",
"total": OrderTotal
}
}
}
isCompanyAdminEmailAvailable
Description
Check whether the specified email can be used to register a company admin.
Response
Returns an IsCompanyAdminEmailAvailableOutput
Arguments
| Name | Description |
|---|---|
email - String!
|
Example
Query
query isCompanyAdminEmailAvailable($email: String!) {
isCompanyAdminEmailAvailable(email: $email) {
is_email_available
}
}
Variables
{"email": "abc123"}
Response
{"data": {"isCompanyAdminEmailAvailable": {"is_email_available": false}}}
isCompanyEmailAvailable
Description
Check whether the specified email can be used to register a new company.
Response
Returns an IsCompanyEmailAvailableOutput
Arguments
| Name | Description |
|---|---|
email - String!
|
Example
Query
query isCompanyEmailAvailable($email: String!) {
isCompanyEmailAvailable(email: $email) {
is_email_available
}
}
Variables
{"email": "abc123"}
Response
{"data": {"isCompanyEmailAvailable": {"is_email_available": true}}}
isCompanyRoleNameAvailable
Description
Check whether the specified role name is valid for the company.
Response
Returns an IsCompanyRoleNameAvailableOutput
Arguments
| Name | Description |
|---|---|
name - String!
|
Example
Query
query isCompanyRoleNameAvailable($name: String!) {
isCompanyRoleNameAvailable(name: $name) {
is_role_name_available
}
}
Variables
{"name": "abc123"}
Response
{"data": {"isCompanyRoleNameAvailable": {"is_role_name_available": true}}}
isCompanyUserEmailAvailable
Description
Check whether the specified email can be used to register a company user.
Response
Returns an IsCompanyUserEmailAvailableOutput
Arguments
| Name | Description |
|---|---|
email - String!
|
Example
Query
query isCompanyUserEmailAvailable($email: String!) {
isCompanyUserEmailAvailable(email: $email) {
is_email_available
}
}
Variables
{"email": "abc123"}
Response
{"data": {"isCompanyUserEmailAvailable": {"is_email_available": true}}}
isEmailAvailable
Description
Check whether the specified email has already been used to create a customer account.
Response
Returns an IsEmailAvailableOutput
Arguments
| Name | Description |
|---|---|
email - String!
|
The email address to check. |
Example
Query
query isEmailAvailable($email: String!) {
isEmailAvailable(email: $email) {
is_email_available
}
}
Variables
{"email": "xyz789"}
Response
{"data": {"isEmailAvailable": {"is_email_available": false}}}
negotiableQuote
Description
Retrieve the specified negotiable quote.
Response
Returns a NegotiableQuote
Arguments
| Name | Description |
|---|---|
uid - ID!
|
Example
Query
query negotiableQuote($uid: ID!) {
negotiableQuote(uid: $uid) {
available_payment_methods {
...AvailablePaymentMethodFragment
}
billing_address {
...NegotiableQuoteBillingAddressFragment
}
buyer {
...NegotiableQuoteUserFragment
}
comments {
...NegotiableQuoteCommentFragment
}
created_at
email
history {
...NegotiableQuoteHistoryEntryFragment
}
is_virtual
items {
...CartItemInterfaceFragment
}
name
prices {
...CartPricesFragment
}
selected_payment_method {
...SelectedPaymentMethodFragment
}
shipping_addresses {
...NegotiableQuoteShippingAddressFragment
}
status
total_quantity
uid
updated_at
}
}
Variables
{"uid": "4"}
Response
{
"data": {
"negotiableQuote": {
"available_payment_methods": [
AvailablePaymentMethod
],
"billing_address": NegotiableQuoteBillingAddress,
"buyer": NegotiableQuoteUser,
"comments": [NegotiableQuoteComment],
"created_at": "abc123",
"email": "xyz789",
"history": [NegotiableQuoteHistoryEntry],
"is_virtual": true,
"items": [CartItemInterface],
"name": "abc123",
"prices": CartPrices,
"selected_payment_method": SelectedPaymentMethod,
"shipping_addresses": [
NegotiableQuoteShippingAddress
],
"status": "SUBMITTED",
"total_quantity": 123.45,
"uid": "4",
"updated_at": "xyz789"
}
}
}
negotiableQuotes
Description
Return a list of negotiable quotes that can be viewed by the logged-in customer.
Response
Returns a NegotiableQuotesOutput
Arguments
| Name | Description |
|---|---|
filter - NegotiableQuoteFilterInput
|
The filter to use to determine which negotiable quotes to return. |
pageSize - Int
|
The maximum number of results to return at once. The default value is 20. Default = 20 |
currentPage - Int
|
The page of results to return. The default value is 1. Default = 1 |
sort - NegotiableQuoteSortInput
|
The field to use for sorting results. |
Example
Query
query negotiableQuotes(
$filter: NegotiableQuoteFilterInput,
$pageSize: Int,
$currentPage: Int,
$sort: NegotiableQuoteSortInput
) {
negotiableQuotes(
filter: $filter,
pageSize: $pageSize,
currentPage: $currentPage,
sort: $sort
) {
items {
...NegotiableQuoteFragment
}
page_info {
...SearchResultPageInfoFragment
}
sort_fields {
...SortFieldsFragment
}
total_count
}
}
Variables
{
"filter": NegotiableQuoteFilterInput,
"pageSize": 20,
"currentPage": 1,
"sort": NegotiableQuoteSortInput
}
Response
{
"data": {
"negotiableQuotes": {
"items": [NegotiableQuote],
"page_info": SearchResultPageInfo,
"sort_fields": SortFields,
"total_count": 987
}
}
}
pickupLocations
Description
The pickup locations query searches for locations that match the search request requirements.
Response
Returns a PickupLocations
Arguments
| Name | Description |
|---|---|
area - AreaInput
|
Perform search by location using radius and search term. |
filters - PickupLocationFilterInput
|
Apply filters by attributes. |
sort - PickupLocationSortInput
|
Specifies which attribute to sort on, and whether to return the results in ascending or descending order. |
pageSize - Int
|
The maximum number of pickup locations to return at once. The attribute is optional. Default = 20 |
currentPage - Int
|
Specifies which page of results to return. The default value is 1. Default = 1 |
productsInfo - [ProductInfoInput]
|
Information about products which should be delivered. |
Example
Query
query pickupLocations(
$area: AreaInput,
$filters: PickupLocationFilterInput,
$sort: PickupLocationSortInput,
$pageSize: Int,
$currentPage: Int,
$productsInfo: [ProductInfoInput]
) {
pickupLocations(
area: $area,
filters: $filters,
sort: $sort,
pageSize: $pageSize,
currentPage: $currentPage,
productsInfo: $productsInfo
) {
items {
...PickupLocationFragment
}
page_info {
...SearchResultPageInfoFragment
}
total_count
}
}
Variables
{
"area": AreaInput,
"filters": PickupLocationFilterInput,
"sort": PickupLocationSortInput,
"pageSize": 20,
"currentPage": 1,
"productsInfo": [ProductInfoInput]
}
Response
{
"data": {
"pickupLocations": {
"items": [PickupLocation],
"page_info": SearchResultPageInfo,
"total_count": 987
}
}
}
productReviewRatingsMetadata
Description
Return the active ratings attributes and the values each rating can have.
Response
Returns a ProductReviewRatingsMetadata!
Example
Query
query productReviewRatingsMetadata {
productReviewRatingsMetadata {
items {
...ProductReviewRatingMetadataFragment
}
}
}
Response
{
"data": {
"productReviewRatingsMetadata": {
"items": [ProductReviewRatingMetadata]
}
}
}
products
Description
Search for products that match the criteria specified in the search and filter attributes.
Response
Returns a Products
Arguments
| Name | Description |
|---|---|
search - String
|
One or more keywords to use in a full-text search. |
filter - ProductAttributeFilterInput
|
The product attributes to search for and return. |
pageSize - Int
|
The maximum number of results to return at once. The default value is 20. Default = 20 |
currentPage - Int
|
The page of results to return. The default value is 1. Default = 1 |
sort - ProductAttributeSortInput
|
Specifies which attributes to sort on, and whether to return the results in ascending or descending order. |
Example
Query
query products(
$search: String,
$filter: ProductAttributeFilterInput,
$pageSize: Int,
$currentPage: Int,
$sort: ProductAttributeSortInput
) {
products(
search: $search,
filter: $filter,
pageSize: $pageSize,
currentPage: $currentPage,
sort: $sort
) {
aggregations {
...AggregationFragment
}
filters {
...LayerFilterFragment
}
items {
...ProductInterfaceFragment
}
page_info {
...SearchResultPageInfoFragment
}
sort_fields {
...SortFieldsFragment
}
suggestions {
...SearchSuggestionFragment
}
total_count
}
}
Variables
{
"search": "xyz789",
"filter": ProductAttributeFilterInput,
"pageSize": 20,
"currentPage": 1,
"sort": ProductAttributeSortInput
}
Response
{
"data": {
"products": {
"aggregations": [Aggregation],
"filters": [LayerFilter],
"items": [ProductInterface],
"page_info": SearchResultPageInfo,
"sort_fields": SortFields,
"suggestions": [SearchSuggestion],
"total_count": 987
}
}
}
recaptchaV3Config
Description
Returns details about Google reCAPTCHA V3-Invisible configuration.
Response
Returns a ReCaptchaConfigurationV3
Example
Query
query recaptchaV3Config {
recaptchaV3Config {
badge_position
failure_message
forms
is_enabled
language_code
minimum_score
website_key
}
}
Response
{
"data": {
"recaptchaV3Config": {
"badge_position": "abc123",
"failure_message": "abc123",
"forms": ["PLACE_ORDER"],
"is_enabled": true,
"language_code": "abc123",
"minimum_score": 987.65,
"website_key": "abc123"
}
}
}
route
Description
Return the full details for a specified product, category, or CMS page.
Response
Returns a RoutableInterface
Arguments
| Name | Description |
|---|---|
url - String!
|
A url_key appended by the `url_suffix, if one exists. |
Example
Query
query route($url: String!) {
route(url: $url) {
redirect_code
relative_url
type
}
}
Variables
{"url": "xyz789"}
Response
{
"data": {
"route": {
"redirect_code": 123,
"relative_url": "xyz789",
"type": "CMS_PAGE"
}
}
}
storeConfig
Description
Return details about the store's configuration.
Response
Returns a StoreConfig
Example
Query
query storeConfig {
storeConfig {
absolute_footer
allow_gift_receipt
allow_gift_wrapping_on_order
allow_gift_wrapping_on_order_items
allow_guests_to_write_product_reviews
allow_items
allow_order
allow_printed_card
autocomplete_on_storefront
base_currency_code
base_link_url
base_media_url
base_static_url
base_url
braintree_3dsecure_allowspecific
braintree_3dsecure_always_request_3ds
braintree_3dsecure_specificcountry
braintree_3dsecure_threshold_amount
braintree_3dsecure_verify_3dsecure
braintree_ach_direct_debit_vault_active
braintree_applepay_merchant_name
braintree_applepay_vault_active
braintree_cc_vault_active
braintree_cc_vault_cvv
braintree_environment
braintree_googlepay_btn_color
braintree_googlepay_cctypes
braintree_googlepay_merchant_id
braintree_googlepay_vault_active
braintree_local_payment_allowed_methods
braintree_local_payment_fallback_button_text
braintree_local_payment_redirect_on_fail
braintree_merchant_account_id
braintree_paypal_button_location_cart_type_credit_color
braintree_paypal_button_location_cart_type_credit_label
braintree_paypal_button_location_cart_type_credit_shape
braintree_paypal_button_location_cart_type_credit_show
braintree_paypal_button_location_cart_type_messaging_layout
braintree_paypal_button_location_cart_type_messaging_logo
braintree_paypal_button_location_cart_type_messaging_logo_position
braintree_paypal_button_location_cart_type_messaging_show
braintree_paypal_button_location_cart_type_messaging_text_color
braintree_paypal_button_location_cart_type_paylater_color
braintree_paypal_button_location_cart_type_paylater_label
braintree_paypal_button_location_cart_type_paylater_shape
braintree_paypal_button_location_cart_type_paylater_show
braintree_paypal_button_location_cart_type_paypal_color
braintree_paypal_button_location_cart_type_paypal_label
braintree_paypal_button_location_cart_type_paypal_shape
braintree_paypal_button_location_cart_type_paypal_show
braintree_paypal_button_location_checkout_type_credit_color
braintree_paypal_button_location_checkout_type_credit_label
braintree_paypal_button_location_checkout_type_credit_shape
braintree_paypal_button_location_checkout_type_credit_show
braintree_paypal_button_location_checkout_type_messaging_layout
braintree_paypal_button_location_checkout_type_messaging_logo
braintree_paypal_button_location_checkout_type_messaging_logo_position
braintree_paypal_button_location_checkout_type_messaging_show
braintree_paypal_button_location_checkout_type_messaging_text_color
braintree_paypal_button_location_checkout_type_paylater_color
braintree_paypal_button_location_checkout_type_paylater_label
braintree_paypal_button_location_checkout_type_paylater_shape
braintree_paypal_button_location_checkout_type_paylater_show
braintree_paypal_button_location_checkout_type_paypal_color
braintree_paypal_button_location_checkout_type_paypal_label
braintree_paypal_button_location_checkout_type_paypal_shape
braintree_paypal_button_location_checkout_type_paypal_show
braintree_paypal_button_location_productpage_type_credit_color
braintree_paypal_button_location_productpage_type_credit_label
braintree_paypal_button_location_productpage_type_credit_shape
braintree_paypal_button_location_productpage_type_credit_show
braintree_paypal_button_location_productpage_type_messaging_layout
braintree_paypal_button_location_productpage_type_messaging_logo
braintree_paypal_button_location_productpage_type_messaging_logo_position
braintree_paypal_button_location_productpage_type_messaging_show
braintree_paypal_button_location_productpage_type_messaging_text_color
braintree_paypal_button_location_productpage_type_paylater_color
braintree_paypal_button_location_productpage_type_paylater_label
braintree_paypal_button_location_productpage_type_paylater_shape
braintree_paypal_button_location_productpage_type_paylater_show
braintree_paypal_button_location_productpage_type_paypal_color
braintree_paypal_button_location_productpage_type_paypal_label
braintree_paypal_button_location_productpage_type_paypal_shape
braintree_paypal_button_location_productpage_type_paypal_show
braintree_paypal_credit_uk_merchant_name
braintree_paypal_display_on_shopping_cart
braintree_paypal_merchant_country
braintree_paypal_merchant_name_override
braintree_paypal_require_billing_address
braintree_paypal_send_cart_line_items
braintree_paypal_vault_active
cart_expires_in_days
cart_gift_wrapping
cart_printed_card
cart_summary_display_quantity
catalog_default_sort_by
category_fixed_product_tax_display_setting
category_url_suffix
check_money_order_enable_for_specific_countries
check_money_order_enabled
check_money_order_make_check_payable_to
check_money_order_max_order_total
check_money_order_min_order_total
check_money_order_new_order_status
check_money_order_payment_from_specific_countries
check_money_order_send_check_to
check_money_order_sort_order
check_money_order_title
cms_home_page
cms_no_cookies
cms_no_route
code
configurable_thumbnail_source
contact_enabled
copyright
countries_with_required_region
create_account_confirmation
customer_access_token_lifetime
default_country
default_description
default_display_currency_code
default_keywords
default_title
demonotice
display_state_if_optional
enable_multiple_wishlists
front
grid_per_page
grid_per_page_values
head_includes
head_shortcut_icon
header_logo_src
id
is_default_store
is_default_store_group
is_guest_checkout_enabled
is_negotiable_quote_active
is_one_page_checkout_enabled
is_requisition_list_active
list_mode
list_per_page
list_per_page_values
locale
logo_alt
logo_height
logo_width
magento_reward_general_is_enabled
magento_reward_general_is_enabled_on_front
magento_reward_general_min_points_balance
magento_reward_general_publish_history
magento_reward_points_invitation_customer
magento_reward_points_invitation_customer_limit
magento_reward_points_invitation_order
magento_reward_points_invitation_order_limit
magento_reward_points_newsletter
magento_reward_points_order
magento_reward_points_register
magento_reward_points_review
magento_reward_points_review_limit
magento_wishlist_general_is_enabled
max_items_in_order_summary
maximum_number_of_wishlists
minicart_display
minicart_max_items
minimum_password_length
newsletter_enabled
no_route
optional_zip_countries
order_cancellation_enabled
order_cancellation_reasons {
...CancellationReasonFragment
}
payment_payflowpro_cc_vault_active
printed_card_price
product_fixed_product_tax_display_setting
product_reviews_enabled
product_url_suffix
quickorder_active
required_character_classes_number
returns_enabled
root_category_id
root_category_uid
sales_fixed_product_tax_display_setting
sales_gift_wrapping
sales_printed_card
secure_base_link_url
secure_base_media_url
secure_base_static_url
secure_base_url
send_friend {
...SendFriendConfigurationFragment
}
shopping_cart_display_full_summary
shopping_cart_display_grand_total
shopping_cart_display_price
shopping_cart_display_shipping
shopping_cart_display_subtotal
shopping_cart_display_tax_gift_wrapping
shopping_cart_display_zero_tax
show_cms_breadcrumbs
store_code
store_group_code
store_group_name
store_name
store_sort_order
timezone
title_prefix
title_separator
title_suffix
use_store_in_url
website_code
website_id
website_name
weight_unit
welcome
zero_subtotal_enable_for_specific_countries
zero_subtotal_enabled
zero_subtotal_new_order_status
zero_subtotal_payment_action
zero_subtotal_payment_from_specific_countries
zero_subtotal_sort_order
zero_subtotal_title
}
}
Response
{
"data": {
"storeConfig": {
"absolute_footer": "xyz789",
"allow_gift_receipt": "xyz789",
"allow_gift_wrapping_on_order": "xyz789",
"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": false,
"base_currency_code": "abc123",
"base_link_url": "abc123",
"base_media_url": "abc123",
"base_static_url": "abc123",
"base_url": "xyz789",
"braintree_3dsecure_allowspecific": false,
"braintree_3dsecure_always_request_3ds": false,
"braintree_3dsecure_specificcountry": "xyz789",
"braintree_3dsecure_threshold_amount": "xyz789",
"braintree_3dsecure_verify_3dsecure": false,
"braintree_ach_direct_debit_vault_active": false,
"braintree_applepay_merchant_name": "xyz789",
"braintree_applepay_vault_active": false,
"braintree_cc_vault_active": "xyz789",
"braintree_cc_vault_cvv": true,
"braintree_environment": "xyz789",
"braintree_googlepay_btn_color": "xyz789",
"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": "xyz789",
"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": "abc123",
"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_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": "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": "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": "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_messaging_layout": "abc123",
"braintree_paypal_button_location_checkout_type_messaging_logo": "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": "xyz789",
"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": 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_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_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_text_color": "xyz789",
"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": "xyz789",
"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_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": false,
"braintree_paypal_vault_active": false,
"cart_expires_in_days": 123,
"cart_gift_wrapping": "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": "abc123",
"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": "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": "xyz789",
"code": "abc123",
"configurable_thumbnail_source": "abc123",
"contact_enabled": false,
"copyright": "xyz789",
"countries_with_required_region": "xyz789",
"create_account_confirmation": true,
"customer_access_token_lifetime": 123.45,
"default_country": "abc123",
"default_description": "xyz789",
"default_display_currency_code": "xyz789",
"default_keywords": "xyz789",
"default_title": "xyz789",
"demonotice": 123,
"display_state_if_optional": false,
"enable_multiple_wishlists": "xyz789",
"front": "xyz789",
"grid_per_page": 123,
"grid_per_page_values": "abc123",
"head_includes": "abc123",
"head_shortcut_icon": "xyz789",
"header_logo_src": "xyz789",
"id": 987,
"is_default_store": true,
"is_default_store_group": true,
"is_guest_checkout_enabled": true,
"is_negotiable_quote_active": true,
"is_one_page_checkout_enabled": false,
"is_requisition_list_active": "abc123",
"list_mode": "abc123",
"list_per_page": 987,
"list_per_page_values": "xyz789",
"locale": "xyz789",
"logo_alt": "abc123",
"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_publish_history": "abc123",
"magento_reward_points_invitation_customer": "abc123",
"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": "xyz789",
"magento_reward_points_register": "abc123",
"magento_reward_points_review": "abc123",
"magento_reward_points_review_limit": "abc123",
"magento_wishlist_general_is_enabled": "xyz789",
"max_items_in_order_summary": 123,
"maximum_number_of_wishlists": "abc123",
"minicart_display": true,
"minicart_max_items": 987,
"minimum_password_length": "abc123",
"newsletter_enabled": false,
"no_route": "xyz789",
"optional_zip_countries": "abc123",
"order_cancellation_enabled": true,
"order_cancellation_reasons": [CancellationReason],
"payment_payflowpro_cc_vault_active": "abc123",
"printed_card_price": "xyz789",
"product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
"product_reviews_enabled": "abc123",
"product_url_suffix": "abc123",
"quickorder_active": true,
"required_character_classes_number": "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": "abc123",
"sales_printed_card": "xyz789",
"secure_base_link_url": "abc123",
"secure_base_media_url": "xyz789",
"secure_base_static_url": "abc123",
"secure_base_url": "xyz789",
"send_friend": SendFriendConfiguration,
"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_subtotal": 123,
"shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX",
"shopping_cart_display_zero_tax": false,
"show_cms_breadcrumbs": 987,
"store_code": "4",
"store_group_code": 4,
"store_group_name": "abc123",
"store_name": "xyz789",
"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": 987,
"website_name": "xyz789",
"weight_unit": "abc123",
"welcome": "abc123",
"zero_subtotal_enable_for_specific_countries": true,
"zero_subtotal_enabled": false,
"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"
}
}
}
urlResolver
Use the
route query instead. Description
Return the relative URL for a specified product, category or CMS page.
Response
Returns an EntityUrl
Arguments
| Name | Description |
|---|---|
url - String!
|
A url_key appended by the `url_suffix, if one exists. |
Example
Query
query urlResolver($url: String!) {
urlResolver(url: $url) {
canonical_url
entity_uid
id
redirectCode
relative_url
type
}
}
Variables
{"url": "abc123"}
Response
{
"data": {
"urlResolver": {
"canonical_url": "abc123",
"entity_uid": "4",
"id": 987,
"redirectCode": 987,
"relative_url": "abc123",
"type": "CMS_PAGE"
}
}
}
wishlist
Moved under
Customer.wishlist. Description
Return the contents of a customer's wish list.
Response
Returns a WishlistOutput
Example
Query
query wishlist {
wishlist {
items {
...WishlistItemFragment
}
items_count
name
sharing_code
updated_at
}
}
Response
{
"data": {
"wishlist": {
"items": [WishlistItem],
"items_count": 987,
"name": "abc123",
"sharing_code": "xyz789",
"updated_at": "abc123"
}
}
}
Mutations
addBundleProductsToCart
Description
Add one or more bundle products to the specified cart. We recommend using addProductsToCart instead.
Response
Returns an AddBundleProductsToCartOutput
Arguments
| Name | Description |
|---|---|
input - AddBundleProductsToCartInput
|
An input object that defines which bundle products to add to the cart. |
Example
Query
mutation addBundleProductsToCart($input: AddBundleProductsToCartInput) {
addBundleProductsToCart(input: $input) {
cart {
...CartFragment
}
}
}
Variables
{"input": AddBundleProductsToCartInput}
Response
{"data": {"addBundleProductsToCart": {"cart": Cart}}}
addConfigurableProductsToCart
Description
Add one or more configurable products to the specified cart. We recommend using addProductsToCart instead.
Response
Returns an AddConfigurableProductsToCartOutput
Arguments
| Name | Description |
|---|---|
input - AddConfigurableProductsToCartInput
|
An input object that defines which configurable products to add to the cart. |
Example
Query
mutation addConfigurableProductsToCart($input: AddConfigurableProductsToCartInput) {
addConfigurableProductsToCart(input: $input) {
cart {
...CartFragment
}
}
}
Variables
{"input": AddConfigurableProductsToCartInput}
Response
{
"data": {
"addConfigurableProductsToCart": {"cart": Cart}
}
}
addDownloadableProductsToCart
Description
Add one or more downloadable products to the specified cart. We recommend using addProductsToCart instead.
Response
Returns an AddDownloadableProductsToCartOutput
Arguments
| Name | Description |
|---|---|
input - AddDownloadableProductsToCartInput
|
An input object that defines which downloadable products to add to the cart. |
Example
Query
mutation addDownloadableProductsToCart($input: AddDownloadableProductsToCartInput) {
addDownloadableProductsToCart(input: $input) {
cart {
...CartFragment
}
}
}
Variables
{"input": AddDownloadableProductsToCartInput}
Response
{
"data": {
"addDownloadableProductsToCart": {"cart": Cart}
}
}
addGiftRegistryRegistrants
Description
Add registrants to the specified gift registry.
Response
Returns an AddGiftRegistryRegistrantsOutput
Arguments
| Name | Description |
|---|---|
giftRegistryUid - ID!
|
The unique ID of the gift registry. |
registrants - [AddGiftRegistryRegistrantInput!]!
|
An array registrants to add. |
Example
Query
mutation addGiftRegistryRegistrants(
$giftRegistryUid: ID!,
$registrants: [AddGiftRegistryRegistrantInput!]!
) {
addGiftRegistryRegistrants(
giftRegistryUid: $giftRegistryUid,
registrants: $registrants
) {
gift_registry {
...GiftRegistryFragment
}
}
}
Variables
{
"giftRegistryUid": 4,
"registrants": [AddGiftRegistryRegistrantInput]
}
Response
{
"data": {
"addGiftRegistryRegistrants": {
"gift_registry": GiftRegistry
}
}
}
addProductsToCart
Description
Add any type of product to the cart.
Response
Returns an AddProductsToCartOutput
Arguments
| Name | Description |
|---|---|
cartId - String!
|
The cart ID of the shopper. |
cartItems - [CartItemInput!]!
|
An array that defines the products to add to the cart. |
Example
Query
mutation addProductsToCart(
$cartId: String!,
$cartItems: [CartItemInput!]!
) {
addProductsToCart(
cartId: $cartId,
cartItems: $cartItems
) {
cart {
...CartFragment
}
user_errors {
...CartUserInputErrorFragment
}
}
}
Variables
{
"cartId": "abc123",
"cartItems": [CartItemInput]
}
Response
{
"data": {
"addProductsToCart": {
"cart": Cart,
"user_errors": [CartUserInputError]
}
}
}
addProductsToCompareList
Description
Add products to the specified compare list.
Response
Returns a CompareList
Arguments
| Name | Description |
|---|---|
input - AddProductsToCompareListInput
|
An input object that defines which products to add to an existing compare list. |
Example
Query
mutation addProductsToCompareList($input: AddProductsToCompareListInput) {
addProductsToCompareList(input: $input) {
attributes {
...ComparableAttributeFragment
}
item_count
items {
...ComparableItemFragment
}
uid
}
}
Variables
{"input": AddProductsToCompareListInput}
Response
{
"data": {
"addProductsToCompareList": {
"attributes": [ComparableAttribute],
"item_count": 987,
"items": [ComparableItem],
"uid": "4"
}
}
}
addProductsToRequisitionList
Description
Add items to the specified requisition list.
Response
Returns an AddProductsToRequisitionListOutput
Arguments
| Name | Description |
|---|---|
requisitionListUid - ID!
|
The unique ID of the requisition list. |
requisitionListItems - [RequisitionListItemsInput!]!
|
An array of products to be added to the requisition list. |
Example
Query
mutation addProductsToRequisitionList(
$requisitionListUid: ID!,
$requisitionListItems: [RequisitionListItemsInput!]!
) {
addProductsToRequisitionList(
requisitionListUid: $requisitionListUid,
requisitionListItems: $requisitionListItems
) {
requisition_list {
...RequisitionListFragment
}
}
}
Variables
{
"requisitionListUid": 4,
"requisitionListItems": [RequisitionListItemsInput]
}
Response
{
"data": {
"addProductsToRequisitionList": {
"requisition_list": RequisitionList
}
}
}
addProductsToWishlist
Description
Add one or more products to the specified wish list. This mutation supports all product types.
Response
Returns an AddProductsToWishlistOutput
Arguments
| Name | Description |
|---|---|
wishlistId - ID!
|
The ID of a wish list. |
wishlistItems - [WishlistItemInput!]!
|
An array of products to add to the wish list. |
Example
Query
mutation addProductsToWishlist(
$wishlistId: ID!,
$wishlistItems: [WishlistItemInput!]!
) {
addProductsToWishlist(
wishlistId: $wishlistId,
wishlistItems: $wishlistItems
) {
user_errors {
...WishListUserInputErrorFragment
}
wishlist {
...WishlistFragment
}
}
}
Variables
{
"wishlistId": "4",
"wishlistItems": [WishlistItemInput]
}
Response
{
"data": {
"addProductsToWishlist": {
"user_errors": [WishListUserInputError],
"wishlist": Wishlist
}
}
}
addPurchaseOrderComment
Description
Add a comment to an existing purchase order.
Response
Returns an AddPurchaseOrderCommentOutput
Arguments
| Name | Description |
|---|---|
input - AddPurchaseOrderCommentInput!
|
Example
Query
mutation addPurchaseOrderComment($input: AddPurchaseOrderCommentInput!) {
addPurchaseOrderComment(input: $input) {
comment {
...PurchaseOrderCommentFragment
}
}
}
Variables
{"input": AddPurchaseOrderCommentInput}
Response
{
"data": {
"addPurchaseOrderComment": {
"comment": PurchaseOrderComment
}
}
}
addPurchaseOrderItemsToCart
Description
Add purchase order items to the shopping cart.
Response
Returns an AddProductsToCartOutput
Arguments
| Name | Description |
|---|---|
input - AddPurchaseOrderItemsToCartInput!
|
Example
Query
mutation addPurchaseOrderItemsToCart($input: AddPurchaseOrderItemsToCartInput!) {
addPurchaseOrderItemsToCart(input: $input) {
cart {
...CartFragment
}
user_errors {
...CartUserInputErrorFragment
}
}
}
Variables
{"input": AddPurchaseOrderItemsToCartInput}
Response
{
"data": {
"addPurchaseOrderItemsToCart": {
"cart": Cart,
"user_errors": [CartUserInputError]
}
}
}
addRequisitionListItemsToCart
Description
Add items in the requisition list to the customer's cart.
Response
Returns an AddRequisitionListItemsToCartOutput
Example
Query
mutation addRequisitionListItemsToCart(
$requisitionListUid: ID!,
$requisitionListItemUids: [ID!]
) {
addRequisitionListItemsToCart(
requisitionListUid: $requisitionListUid,
requisitionListItemUids: $requisitionListItemUids
) {
add_requisition_list_items_to_cart_user_errors {
...AddRequisitionListItemToCartUserErrorFragment
}
cart {
...CartFragment
}
status
}
}
Variables
{"requisitionListUid": 4, "requisitionListItemUids": [4]}
Response
{
"data": {
"addRequisitionListItemsToCart": {
"add_requisition_list_items_to_cart_user_errors": [
AddRequisitionListItemToCartUserError
],
"cart": Cart,
"status": false
}
}
}
addReturnComment
Description
Add a comment to an existing return.
Response
Returns an AddReturnCommentOutput
Arguments
| Name | Description |
|---|---|
input - AddReturnCommentInput!
|
An input object that defines a return comment. |
Example
Query
mutation addReturnComment($input: AddReturnCommentInput!) {
addReturnComment(input: $input) {
return {
...ReturnFragment
}
}
}
Variables
{"input": AddReturnCommentInput}
Response
{"data": {"addReturnComment": {"return": Return}}}
addReturnTracking
Description
Add tracking information to the return.
Response
Returns an AddReturnTrackingOutput
Arguments
| Name | Description |
|---|---|
input - AddReturnTrackingInput!
|
An input object that defines tracking information. |
Example
Query
mutation addReturnTracking($input: AddReturnTrackingInput!) {
addReturnTracking(input: $input) {
return {
...ReturnFragment
}
return_shipping_tracking {
...ReturnShippingTrackingFragment
}
}
}
Variables
{"input": AddReturnTrackingInput}
Response
{
"data": {
"addReturnTracking": {
"return": Return,
"return_shipping_tracking": ReturnShippingTracking
}
}
}
addSimpleProductsToCart
Description
Add one or more simple products to the specified cart. We recommend using addProductsToCart instead.
Response
Returns an AddSimpleProductsToCartOutput
Arguments
| Name | Description |
|---|---|
input - AddSimpleProductsToCartInput
|
An input object that defines which simple products to add to the cart. |
Example
Query
mutation addSimpleProductsToCart($input: AddSimpleProductsToCartInput) {
addSimpleProductsToCart(input: $input) {
cart {
...CartFragment
}
}
}
Variables
{"input": AddSimpleProductsToCartInput}
Response
{"data": {"addSimpleProductsToCart": {"cart": Cart}}}
addVirtualProductsToCart
Description
Add one or more virtual products to the specified cart. We recommend using addProductsToCart instead.
Response
Returns an AddVirtualProductsToCartOutput
Arguments
| Name | Description |
|---|---|
input - AddVirtualProductsToCartInput
|
An input object that defines which virtual products to add to the cart. |
Example
Query
mutation addVirtualProductsToCart($input: AddVirtualProductsToCartInput) {
addVirtualProductsToCart(input: $input) {
cart {
...CartFragment
}
}
}
Variables
{"input": AddVirtualProductsToCartInput}
Response
{"data": {"addVirtualProductsToCart": {"cart": Cart}}}
addWishlistItemsToCart
Description
Add items in the specified wishlist to the customer's cart.
Response
Returns an AddWishlistItemsToCartOutput
Example
Query
mutation addWishlistItemsToCart(
$wishlistId: ID!,
$wishlistItemIds: [ID!]
) {
addWishlistItemsToCart(
wishlistId: $wishlistId,
wishlistItemIds: $wishlistItemIds
) {
add_wishlist_items_to_cart_user_errors {
...WishlistCartUserInputErrorFragment
}
status
wishlist {
...WishlistFragment
}
}
}
Variables
{
"wishlistId": "4",
"wishlistItemIds": ["4"]
}
Response
{
"data": {
"addWishlistItemsToCart": {
"add_wishlist_items_to_cart_user_errors": [
WishlistCartUserInputError
],
"status": false,
"wishlist": Wishlist
}
}
}
applyCouponToCart
Description
Apply a pre-defined coupon code to the specified cart.
Response
Returns an ApplyCouponToCartOutput
Arguments
| Name | Description |
|---|---|
input - ApplyCouponToCartInput
|
An input object that defines the coupon code to apply to the cart. |
Example
Query
mutation applyCouponToCart($input: ApplyCouponToCartInput) {
applyCouponToCart(input: $input) {
cart {
...CartFragment
}
}
}
Variables
{"input": ApplyCouponToCartInput}
Response
{"data": {"applyCouponToCart": {"cart": Cart}}}
applyCouponsToCart
Description
Apply a pre-defined coupon code to the specified cart.
Response
Returns an ApplyCouponToCartOutput
Arguments
| Name | Description |
|---|---|
input - ApplyCouponsToCartInput
|
An input object that defines the coupon code to apply to the cart. |
Example
Query
mutation applyCouponsToCart($input: ApplyCouponsToCartInput) {
applyCouponsToCart(input: $input) {
cart {
...CartFragment
}
}
}
Variables
{"input": ApplyCouponsToCartInput}
Response
{"data": {"applyCouponsToCart": {"cart": Cart}}}
applyGiftCardToCart
Description
Apply a pre-defined gift card code to the specified cart.
Response
Returns an ApplyGiftCardToCartOutput
Arguments
| Name | Description |
|---|---|
input - ApplyGiftCardToCartInput
|
An input object that specifies the gift card code and cart. |
Example
Query
mutation applyGiftCardToCart($input: ApplyGiftCardToCartInput) {
applyGiftCardToCart(input: $input) {
cart {
...CartFragment
}
}
}
Variables
{"input": ApplyGiftCardToCartInput}
Response
{"data": {"applyGiftCardToCart": {"cart": Cart}}}
applyRewardPointsToCart
Description
Apply all available points, up to the cart total. Partial redemption is not available.
Response
Returns an ApplyRewardPointsToCartOutput
Arguments
| Name | Description |
|---|---|
cartId - ID!
|
Example
Query
mutation applyRewardPointsToCart($cartId: ID!) {
applyRewardPointsToCart(cartId: $cartId) {
cart {
...CartFragment
}
}
}
Variables
{"cartId": "4"}
Response
{"data": {"applyRewardPointsToCart": {"cart": Cart}}}
applyStoreCreditToCart
Description
Apply store credit to the specified cart.
Response
Returns an ApplyStoreCreditToCartOutput
Arguments
| Name | Description |
|---|---|
input - ApplyStoreCreditToCartInput!
|
An input object that specifies the cart ID. |
Example
Query
mutation applyStoreCreditToCart($input: ApplyStoreCreditToCartInput!) {
applyStoreCreditToCart(input: $input) {
cart {
...CartFragment
}
}
}
Variables
{"input": ApplyStoreCreditToCartInput}
Response
{"data": {"applyStoreCreditToCart": {"cart": Cart}}}
approvePurchaseOrders
Description
Approve purchase orders.
Response
Returns a PurchaseOrdersActionOutput
Arguments
| Name | Description |
|---|---|
input - PurchaseOrdersActionInput!
|
Example
Query
mutation approvePurchaseOrders($input: PurchaseOrdersActionInput!) {
approvePurchaseOrders(input: $input) {
errors {
...PurchaseOrderActionErrorFragment
}
purchase_orders {
...PurchaseOrderFragment
}
}
}
Variables
{"input": PurchaseOrdersActionInput}
Response
{
"data": {
"approvePurchaseOrders": {
"errors": [PurchaseOrderActionError],
"purchase_orders": [PurchaseOrder]
}
}
}
assignCompareListToCustomer
Description
Assign the specified compare list to the logged in customer.
Response
Returns an AssignCompareListToCustomerOutput
Arguments
| Name | Description |
|---|---|
uid - ID!
|
The unique ID of the compare list to be assigned. |
Example
Query
mutation assignCompareListToCustomer($uid: ID!) {
assignCompareListToCustomer(uid: $uid) {
compare_list {
...CompareListFragment
}
result
}
}
Variables
{"uid": 4}
Response
{
"data": {
"assignCompareListToCustomer": {
"compare_list": CompareList,
"result": false
}
}
}
assignCustomerToGuestCart
Description
Assign a logged-in customer to the specified guest shopping cart.
Example
Query
mutation assignCustomerToGuestCart($cart_id: String!) {
assignCustomerToGuestCart(cart_id: $cart_id) {
applied_coupon {
...AppliedCouponFragment
}
applied_coupons {
...AppliedCouponFragment
}
applied_gift_cards {
...AppliedGiftCardFragment
}
applied_reward_points {
...RewardPointsAmountFragment
}
applied_store_credit {
...AppliedStoreCreditFragment
}
available_gift_wrappings {
...GiftWrappingFragment
}
available_payment_methods {
...AvailablePaymentMethodFragment
}
billing_address {
...BillingCartAddressFragment
}
email
gift_message {
...GiftMessageFragment
}
gift_receipt_included
gift_wrapping {
...GiftWrappingFragment
}
id
is_virtual
items {
...CartItemInterfaceFragment
}
itemsV2 {
...CartItemsFragment
}
prices {
...CartPricesFragment
}
printed_card_included
selected_payment_method {
...SelectedPaymentMethodFragment
}
shipping_addresses {
...ShippingCartAddressFragment
}
total_quantity
}
}
Variables
{"cart_id": "xyz789"}
Response
{
"data": {
"assignCustomerToGuestCart": {
"applied_coupon": AppliedCoupon,
"applied_coupons": [AppliedCoupon],
"applied_gift_cards": [AppliedGiftCard],
"applied_reward_points": RewardPointsAmount,
"applied_store_credit": AppliedStoreCredit,
"available_gift_wrappings": [GiftWrapping],
"available_payment_methods": [
AvailablePaymentMethod
],
"billing_address": BillingCartAddress,
"email": "xyz789",
"gift_message": GiftMessage,
"gift_receipt_included": true,
"gift_wrapping": GiftWrapping,
"id": 4,
"is_virtual": true,
"items": [CartItemInterface],
"itemsV2": CartItems,
"prices": CartPrices,
"printed_card_included": true,
"selected_payment_method": SelectedPaymentMethod,
"shipping_addresses": [ShippingCartAddress],
"total_quantity": 987.65
}
}
}
cancelOrder
Description
Cancel the specified customer order.
Response
Returns a CancelOrderOutput
Arguments
| Name | Description |
|---|---|
input - CancelOrderInput!
|
Example
Query
mutation cancelOrder($input: CancelOrderInput!) {
cancelOrder(input: $input) {
error
order {
...CustomerOrderFragment
}
}
}
Variables
{"input": CancelOrderInput}
Response
{
"data": {
"cancelOrder": {
"error": "xyz789",
"order": CustomerOrder
}
}
}
cancelPurchaseOrders
Description
Cancel purchase orders.
Response
Returns a PurchaseOrdersActionOutput
Arguments
| Name | Description |
|---|---|
input - PurchaseOrdersActionInput!
|
Example
Query
mutation cancelPurchaseOrders($input: PurchaseOrdersActionInput!) {
cancelPurchaseOrders(input: $input) {
errors {
...PurchaseOrderActionErrorFragment
}
purchase_orders {
...PurchaseOrderFragment
}
}
}
Variables
{"input": PurchaseOrdersActionInput}
Response
{
"data": {
"cancelPurchaseOrders": {
"errors": [PurchaseOrderActionError],
"purchase_orders": [PurchaseOrder]
}
}
}
changeCustomerPassword
Description
Change the password for the logged-in customer.
Response
Returns a Customer
Example
Query
mutation changeCustomerPassword(
$currentPassword: String!,
$newPassword: String!
) {
changeCustomerPassword(
currentPassword: $currentPassword,
newPassword: $newPassword
) {
addresses {
...CustomerAddressFragment
}
allow_remote_shopping_assistance
compare_list {
...CompareListFragment
}
confirmation_status
created_at
custom_attributes {
...AttributeValueInterfaceFragment
}
date_of_birth
default_billing
default_shipping
dob
email
firstname
gender
gift_registries {
...GiftRegistryFragment
}
gift_registry {
...GiftRegistryFragment
}
group_id
id
is_subscribed
job_title
lastname
middlename
orders {
...CustomerOrdersFragment
}
prefix
purchase_order {
...PurchaseOrderFragment
}
purchase_order_approval_rule {
...PurchaseOrderApprovalRuleFragment
}
purchase_order_approval_rule_metadata {
...PurchaseOrderApprovalRuleMetadataFragment
}
purchase_order_approval_rules {
...PurchaseOrderApprovalRulesFragment
}
purchase_orders {
...PurchaseOrdersFragment
}
purchase_orders_enabled
requisition_lists {
...RequisitionListsFragment
}
return {
...ReturnFragment
}
returns {
...ReturnsFragment
}
reviews {
...ProductReviewsFragment
}
reward_points {
...RewardPointsFragment
}
role {
...CompanyRoleFragment
}
status
store_credit {
...CustomerStoreCreditFragment
}
structure_id
suffix
taxvat
team {
...CompanyTeamFragment
}
telephone
wishlist {
...WishlistFragment
}
wishlist_v2 {
...WishlistFragment
}
wishlists {
...WishlistFragment
}
}
}
Variables
{
"currentPassword": "abc123",
"newPassword": "xyz789"
}
Response
{
"data": {
"changeCustomerPassword": {
"addresses": [CustomerAddress],
"allow_remote_shopping_assistance": false,
"compare_list": CompareList,
"confirmation_status": "ACCOUNT_CONFIRMED",
"created_at": "xyz789",
"custom_attributes": [AttributeValueInterface],
"date_of_birth": "xyz789",
"default_billing": "abc123",
"default_shipping": "abc123",
"dob": "xyz789",
"email": "abc123",
"firstname": "xyz789",
"gender": 987,
"gift_registries": [GiftRegistry],
"gift_registry": GiftRegistry,
"group_id": 123,
"id": 987,
"is_subscribed": false,
"job_title": "xyz789",
"lastname": "xyz789",
"middlename": "abc123",
"orders": CustomerOrders,
"prefix": "abc123",
"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,
"requisition_lists": RequisitionLists,
"return": Return,
"returns": Returns,
"reviews": ProductReviews,
"reward_points": RewardPoints,
"role": CompanyRole,
"status": "ACTIVE",
"store_credit": CustomerStoreCredit,
"structure_id": "4",
"suffix": "xyz789",
"taxvat": "xyz789",
"team": CompanyTeam,
"telephone": "xyz789",
"wishlist": Wishlist,
"wishlist_v2": Wishlist,
"wishlists": [Wishlist]
}
}
}
clearCart
Description
Remove all items from the specified cart.
Response
Returns a ClearCartOutput!
Arguments
| Name | Description |
|---|---|
input - ClearCartInput!
|
An input object that defines cart ID of the shopper. |
Example
Query
mutation clearCart($input: ClearCartInput!) {
clearCart(input: $input) {
cart {
...CartFragment
}
errors {
...ClearCartErrorFragment
}
}
}
Variables
{"input": ClearCartInput}
Response
{
"data": {
"clearCart": {
"cart": Cart,
"errors": [ClearCartError]
}
}
}
clearCustomerCart
Description
Remove all items from the specified cart.
Response
Returns a ClearCustomerCartOutput
Arguments
| Name | Description |
|---|---|
cartUid - String!
|
The masked ID of the cart. |
Example
Query
mutation clearCustomerCart($cartUid: String!) {
clearCustomerCart(cartUid: $cartUid) {
cart {
...CartFragment
}
status
}
}
Variables
{"cartUid": "abc123"}
Response
{
"data": {
"clearCustomerCart": {"cart": Cart, "status": true}
}
}
closeNegotiableQuotes
Description
Mark a negotiable quote as closed. The negotiable quote is still visible on the storefront.
Response
Returns a CloseNegotiableQuotesOutput
Arguments
| Name | Description |
|---|---|
input - CloseNegotiableQuotesInput!
|
An input object that closes a negotiable quote. |
Example
Query
mutation closeNegotiableQuotes($input: CloseNegotiableQuotesInput!) {
closeNegotiableQuotes(input: $input) {
closed_quotes {
...NegotiableQuoteFragment
}
negotiable_quotes {
...NegotiableQuotesOutputFragment
}
operation_results {
... on NegotiableQuoteUidOperationSuccess {
...NegotiableQuoteUidOperationSuccessFragment
}
... on CloseNegotiableQuoteOperationFailure {
...CloseNegotiableQuoteOperationFailureFragment
}
}
result_status
}
}
Variables
{"input": CloseNegotiableQuotesInput}
Response
{
"data": {
"closeNegotiableQuotes": {
"closed_quotes": [NegotiableQuote],
"negotiable_quotes": NegotiableQuotesOutput,
"operation_results": [
NegotiableQuoteUidOperationSuccess
],
"result_status": "SUCCESS"
}
}
}
confirmEmail
Description
Confirms the email address for a customer.
Response
Returns a CustomerOutput
Arguments
| Name | Description |
|---|---|
input - ConfirmEmailInput!
|
An input object to identify the customer to confirm the email. |
Example
Query
mutation confirmEmail($input: ConfirmEmailInput!) {
confirmEmail(input: $input) {
customer {
...CustomerFragment
}
}
}
Variables
{"input": ConfirmEmailInput}
Response
{"data": {"confirmEmail": {"customer": Customer}}}
contactUs
Description
Send a 'Contact Us' email to the merchant.
Response
Returns a ContactUsOutput
Arguments
| Name | Description |
|---|---|
input - ContactUsInput!
|
An input object that defines shopper information. |
Example
Query
mutation contactUs($input: ContactUsInput!) {
contactUs(input: $input) {
status
}
}
Variables
{"input": ContactUsInput}
Response
{"data": {"contactUs": {"status": false}}}
copyItemsBetweenRequisitionLists
Description
Copy items from one requisition list to another.
Response
Returns a CopyItemsFromRequisitionListsOutput
Arguments
| Name | Description |
|---|---|
sourceRequisitionListUid - ID!
|
The unique ID of the source requisition list. |
destinationRequisitionListUid - ID
|
The unique ID of the destination requisition list. If null, a new requisition list will be created. |
requisitionListItem - CopyItemsBetweenRequisitionListsInput
|
The list of products to copy. |
Example
Query
mutation copyItemsBetweenRequisitionLists(
$sourceRequisitionListUid: ID!,
$destinationRequisitionListUid: ID,
$requisitionListItem: CopyItemsBetweenRequisitionListsInput
) {
copyItemsBetweenRequisitionLists(
sourceRequisitionListUid: $sourceRequisitionListUid,
destinationRequisitionListUid: $destinationRequisitionListUid,
requisitionListItem: $requisitionListItem
) {
requisition_list {
...RequisitionListFragment
}
}
}
Variables
{
"sourceRequisitionListUid": 4,
"destinationRequisitionListUid": 4,
"requisitionListItem": CopyItemsBetweenRequisitionListsInput
}
Response
{
"data": {
"copyItemsBetweenRequisitionLists": {
"requisition_list": RequisitionList
}
}
}
copyProductsBetweenWishlists
Description
Copy products from one wish list to another. The original wish list is unchanged.
Response
Returns a CopyProductsBetweenWishlistsOutput
Arguments
| Name | Description |
|---|---|
sourceWishlistUid - ID!
|
The ID of the original wish list. |
destinationWishlistUid - ID!
|
The ID of the target wish list. |
wishlistItems - [WishlistItemCopyInput!]!
|
An array of items to copy. |
Example
Query
mutation copyProductsBetweenWishlists(
$sourceWishlistUid: ID!,
$destinationWishlistUid: ID!,
$wishlistItems: [WishlistItemCopyInput!]!
) {
copyProductsBetweenWishlists(
sourceWishlistUid: $sourceWishlistUid,
destinationWishlistUid: $destinationWishlistUid,
wishlistItems: $wishlistItems
) {
destination_wishlist {
...WishlistFragment
}
source_wishlist {
...WishlistFragment
}
user_errors {
...WishListUserInputErrorFragment
}
}
}
Variables
{
"sourceWishlistUid": "4",
"destinationWishlistUid": 4,
"wishlistItems": [WishlistItemCopyInput]
}
Response
{
"data": {
"copyProductsBetweenWishlists": {
"destination_wishlist": Wishlist,
"source_wishlist": Wishlist,
"user_errors": [WishListUserInputError]
}
}
}
createBraintreeClientToken
Description
Creates Client Token for Braintree Javascript SDK initialization.
Response
Returns a String!
Example
Query
mutation createBraintreeClientToken {
createBraintreeClientToken
}
Response
{
"data": {
"createBraintreeClientToken": "xyz789"
}
}
createBraintreePayPalClientToken
Description
Creates Client Token for Braintree PayPal Javascript SDK initialization.
Response
Returns a String!
Example
Query
mutation createBraintreePayPalClientToken {
createBraintreePayPalClientToken
}
Response
{
"data": {
"createBraintreePayPalClientToken": "abc123"
}
}
createBraintreePayPalVaultClientToken
Description
Creates Client Token for Braintree PayPal Vault Javascript SDK initialization.
Response
Returns a String!
Arguments
| Name | Description |
|---|---|
input - BraintreeVaultInput
|
Example
Query
mutation createBraintreePayPalVaultClientToken($input: BraintreeVaultInput) {
createBraintreePayPalVaultClientToken(input: $input)
}
Variables
{"input": BraintreeVaultInput}
Response
{
"data": {
"createBraintreePayPalVaultClientToken": "abc123"
}
}
createCompany
Description
Create a company at the request of either a customer or a guest.
Response
Returns a CreateCompanyOutput
Arguments
| Name | Description |
|---|---|
input - CompanyCreateInput!
|
Example
Query
mutation createCompany($input: CompanyCreateInput!) {
createCompany(input: $input) {
company {
...CompanyFragment
}
}
}
Variables
{"input": CompanyCreateInput}
Response
{"data": {"createCompany": {"company": Company}}}
createCompanyRole
Description
Create a new company role.
Response
Returns a CreateCompanyRoleOutput
Arguments
| Name | Description |
|---|---|
input - CompanyRoleCreateInput!
|
Example
Query
mutation createCompanyRole($input: CompanyRoleCreateInput!) {
createCompanyRole(input: $input) {
role {
...CompanyRoleFragment
}
}
}
Variables
{"input": CompanyRoleCreateInput}
Response
{"data": {"createCompanyRole": {"role": CompanyRole}}}
createCompanyTeam
Description
Create a new team for the authenticated customer's company.
Response
Returns a CreateCompanyTeamOutput
Arguments
| Name | Description |
|---|---|
input - CompanyTeamCreateInput!
|
Example
Query
mutation createCompanyTeam($input: CompanyTeamCreateInput!) {
createCompanyTeam(input: $input) {
team {
...CompanyTeamFragment
}
}
}
Variables
{"input": CompanyTeamCreateInput}
Response
{"data": {"createCompanyTeam": {"team": CompanyTeam}}}
createCompanyUser
Description
Create a new company user at the request of an existing customer.
Response
Returns a CreateCompanyUserOutput
Arguments
| Name | Description |
|---|---|
input - CompanyUserCreateInput!
|
Example
Query
mutation createCompanyUser($input: CompanyUserCreateInput!) {
createCompanyUser(input: $input) {
user {
...CustomerFragment
}
}
}
Variables
{"input": CompanyUserCreateInput}
Response
{"data": {"createCompanyUser": {"user": Customer}}}
createCompareList
Description
Create a new compare list. The compare list is saved for logged in customers.
Response
Returns a CompareList
Arguments
| Name | Description |
|---|---|
input - CreateCompareListInput
|
Example
Query
mutation createCompareList($input: CreateCompareListInput) {
createCompareList(input: $input) {
attributes {
...ComparableAttributeFragment
}
item_count
items {
...ComparableItemFragment
}
uid
}
}
Variables
{"input": CreateCompareListInput}
Response
{
"data": {
"createCompareList": {
"attributes": [ComparableAttribute],
"item_count": 123,
"items": [ComparableItem],
"uid": "4"
}
}
}
createCustomer
Description
Use createCustomerV2 instead.
Response
Returns a CustomerOutput
Arguments
| Name | Description |
|---|---|
input - CustomerInput!
|
An input object that defines the customer to be created. |
Example
Query
mutation createCustomer($input: CustomerInput!) {
createCustomer(input: $input) {
customer {
...CustomerFragment
}
}
}
Variables
{"input": CustomerInput}
Response
{"data": {"createCustomer": {"customer": Customer}}}
createCustomerAddress
Description
Create a billing or shipping address for a customer or guest.
Response
Returns a CustomerAddress
Arguments
| Name | Description |
|---|---|
input - CustomerAddressInput!
|
Example
Query
mutation createCustomerAddress($input: CustomerAddressInput!) {
createCustomerAddress(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
vat_id
}
}
Variables
{"input": CustomerAddressInput}
Response
{
"data": {
"createCustomerAddress": {
"city": "abc123",
"company": "abc123",
"country_code": "AF",
"country_id": "abc123",
"custom_attributes": [CustomerAddressAttribute],
"custom_attributesV2": [AttributeValueInterface],
"customer_id": 987,
"default_billing": false,
"default_shipping": false,
"extension_attributes": [CustomerAddressAttribute],
"fax": "xyz789",
"firstname": "abc123",
"id": 987,
"lastname": "abc123",
"middlename": "xyz789",
"postcode": "abc123",
"prefix": "xyz789",
"region": CustomerAddressRegion,
"region_id": 123,
"street": ["xyz789"],
"suffix": "abc123",
"telephone": "xyz789",
"vat_id": "xyz789"
}
}
}
createCustomerV2
Description
Create a customer account.
Response
Returns a CustomerOutput
Arguments
| Name | Description |
|---|---|
input - CustomerCreateInput!
|
An input object that defines the customer to be created. |
Example
Query
mutation createCustomerV2($input: CustomerCreateInput!) {
createCustomerV2(input: $input) {
customer {
...CustomerFragment
}
}
}
Variables
{"input": CustomerCreateInput}
Response
{"data": {"createCustomerV2": {"customer": Customer}}}
createEmptyCart
Use
Mutation.createGuestCart or Query.customerCart for logged in customer Description
Create an empty shopping cart for a guest or logged in user
Response
Returns a String
Arguments
| Name | Description |
|---|---|
input - createEmptyCartInput
|
An optional input object that assigns the specified ID to the cart. |
Example
Query
mutation createEmptyCart($input: createEmptyCartInput) {
createEmptyCart(input: $input)
}
Variables
{"input": createEmptyCartInput}
Response
{"data": {"createEmptyCart": "abc123"}}
createGiftRegistry
Description
Create a gift registry on behalf of the customer.
Response
Returns a CreateGiftRegistryOutput
Arguments
| Name | Description |
|---|---|
giftRegistry - CreateGiftRegistryInput!
|
An input object that defines a new gift registry. |
Example
Query
mutation createGiftRegistry($giftRegistry: CreateGiftRegistryInput!) {
createGiftRegistry(giftRegistry: $giftRegistry) {
gift_registry {
...GiftRegistryFragment
}
}
}
Variables
{"giftRegistry": CreateGiftRegistryInput}
Response
{
"data": {
"createGiftRegistry": {"gift_registry": GiftRegistry}
}
}
createGuestCart
Description
Create a new shopping cart
Response
Returns a CreateGuestCartOutput
Arguments
| Name | Description |
|---|---|
input - CreateGuestCartInput
|
Example
Query
mutation createGuestCart($input: CreateGuestCartInput) {
createGuestCart(input: $input) {
cart {
...CartFragment
}
}
}
Variables
{"input": CreateGuestCartInput}
Response
{"data": {"createGuestCart": {"cart": Cart}}}
createPayflowProToken
Description
Initiate a transaction and receive a token. Use this mutation for Payflow Pro and Payments Pro payment methods
Response
Returns a CreatePayflowProTokenOutput
Arguments
| Name | Description |
|---|---|
input - PayflowProTokenInput!
|
An input object that defines the requirements to fetch payment token information. |
Example
Query
mutation createPayflowProToken($input: PayflowProTokenInput!) {
createPayflowProToken(input: $input) {
response_message
result
result_code
secure_token
secure_token_id
}
}
Variables
{"input": PayflowProTokenInput}
Response
{
"data": {
"createPayflowProToken": {
"response_message": "xyz789",
"result": 987,
"result_code": 123,
"secure_token": "xyz789",
"secure_token_id": "abc123"
}
}
}
createPaymentOrder
Description
Creates a payment order for further payment processing
Response
Returns a CreatePaymentOrderOutput
Arguments
| Name | Description |
|---|---|
input - CreatePaymentOrderInput!
|
Contains payment order details that are used while processing the payment order |
Example
Query
mutation createPaymentOrder($input: CreatePaymentOrderInput!) {
createPaymentOrder(input: $input) {
id
mp_order_id
status
}
}
Variables
{"input": CreatePaymentOrderInput}
Response
{
"data": {
"createPaymentOrder": {
"id": "xyz789",
"mp_order_id": "xyz789",
"status": "xyz789"
}
}
}
createPaypalExpressToken
Description
Initiate an Express Checkout transaction and receive a token. Use this mutation for Express Checkout and Payments Standard payment methods.
Response
Returns a PaypalExpressTokenOutput
Arguments
| Name | Description |
|---|---|
input - PaypalExpressTokenInput!
|
An input object that defines the requirements to receive a payment token. |
Example
Query
mutation createPaypalExpressToken($input: PaypalExpressTokenInput!) {
createPaypalExpressToken(input: $input) {
paypal_urls {
...PaypalExpressUrlListFragment
}
token
}
}
Variables
{"input": PaypalExpressTokenInput}
Response
{
"data": {
"createPaypalExpressToken": {
"paypal_urls": PaypalExpressUrlList,
"token": "abc123"
}
}
}
createProductReview
Description
Create a product review for the specified product.
Response
Returns a CreateProductReviewOutput!
Arguments
| Name | Description |
|---|---|
input - CreateProductReviewInput!
|
An input object that contains the details necessary to create a product review. |
Example
Query
mutation createProductReview($input: CreateProductReviewInput!) {
createProductReview(input: $input) {
review {
...ProductReviewFragment
}
}
}
Variables
{"input": CreateProductReviewInput}
Response
{
"data": {
"createProductReview": {"review": ProductReview}
}
}
createPurchaseOrderApprovalRule
Description
Create a purchase order approval rule.
Response
Returns a PurchaseOrderApprovalRule
Arguments
| Name | Description |
|---|---|
input - PurchaseOrderApprovalRuleInput!
|
Example
Query
mutation createPurchaseOrderApprovalRule($input: PurchaseOrderApprovalRuleInput!) {
createPurchaseOrderApprovalRule(input: $input) {
applies_to_roles {
...CompanyRoleFragment
}
approver_roles {
...CompanyRoleFragment
}
condition {
...PurchaseOrderApprovalRuleConditionInterfaceFragment
}
created_at
created_by
description
name
status
uid
updated_at
}
}
Variables
{"input": PurchaseOrderApprovalRuleInput}
Response
{
"data": {
"createPurchaseOrderApprovalRule": {
"applies_to_roles": [CompanyRole],
"approver_roles": [CompanyRole],
"condition": PurchaseOrderApprovalRuleConditionInterface,
"created_at": "xyz789",
"created_by": "xyz789",
"description": "abc123",
"name": "xyz789",
"status": "ENABLED",
"uid": 4,
"updated_at": "abc123"
}
}
}
createRequisitionList
Description
Create an empty requisition list.
Response
Returns a CreateRequisitionListOutput
Arguments
| Name | Description |
|---|---|
input - CreateRequisitionListInput
|
Example
Query
mutation createRequisitionList($input: CreateRequisitionListInput) {
createRequisitionList(input: $input) {
requisition_list {
...RequisitionListFragment
}
}
}
Variables
{"input": CreateRequisitionListInput}
Response
{
"data": {
"createRequisitionList": {
"requisition_list": RequisitionList
}
}
}
createWishlist
Description
Create a new wish list.
Response
Returns a CreateWishlistOutput
Arguments
| Name | Description |
|---|---|
input - CreateWishlistInput!
|
An input object that defines a new wish list. |
Example
Query
mutation createWishlist($input: CreateWishlistInput!) {
createWishlist(input: $input) {
wishlist {
...WishlistFragment
}
}
}
Variables
{"input": CreateWishlistInput}
Response
{"data": {"createWishlist": {"wishlist": Wishlist}}}
deleteCompanyRole
Description
Delete the specified company role.
Response
Returns a DeleteCompanyRoleOutput
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation deleteCompanyRole($id: ID!) {
deleteCompanyRole(id: $id) {
success
}
}
Variables
{"id": "4"}
Response
{"data": {"deleteCompanyRole": {"success": true}}}
deleteCompanyTeam
Description
Delete the specified company team.
Response
Returns a DeleteCompanyTeamOutput
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation deleteCompanyTeam($id: ID!) {
deleteCompanyTeam(id: $id) {
success
}
}
Variables
{"id": 4}
Response
{"data": {"deleteCompanyTeam": {"success": false}}}
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) {
success
}
}
Variables
{"id": "4"}
Response
{"data": {"deleteCompanyUser": {"success": true}}}
deleteCompareList
Description
Delete the specified compare list.
Response
Returns a DeleteCompareListOutput
Arguments
| Name | Description |
|---|---|
uid - ID!
|
The unique ID of the compare list to be deleted. |
Example
Query
mutation deleteCompareList($uid: ID!) {
deleteCompareList(uid: $uid) {
result
}
}
Variables
{"uid": 4}
Response
{"data": {"deleteCompareList": {"result": true}}}
deleteCustomer
Description
Delete customer account
Response
Returns a Boolean
Example
Query
mutation deleteCustomer {
deleteCustomer
}
Response
{"data": {"deleteCustomer": true}}
deleteCustomerAddress
Description
Delete the billing or shipping address of a customer.
deleteNegotiableQuotes
Description
Delete a negotiable quote. The negotiable quote will not be displayed on the storefront.
Response
Returns a DeleteNegotiableQuotesOutput
Arguments
| Name | Description |
|---|---|
input - DeleteNegotiableQuotesInput!
|
An input object that deletes a negotiable quote. |
Example
Query
mutation deleteNegotiableQuotes($input: DeleteNegotiableQuotesInput!) {
deleteNegotiableQuotes(input: $input) {
negotiable_quotes {
...NegotiableQuotesOutputFragment
}
operation_results {
... on NegotiableQuoteUidOperationSuccess {
...NegotiableQuoteUidOperationSuccessFragment
}
... on DeleteNegotiableQuoteOperationFailure {
...DeleteNegotiableQuoteOperationFailureFragment
}
}
result_status
}
}
Variables
{"input": DeleteNegotiableQuotesInput}
Response
{
"data": {
"deleteNegotiableQuotes": {
"negotiable_quotes": NegotiableQuotesOutput,
"operation_results": [
NegotiableQuoteUidOperationSuccess
],
"result_status": "SUCCESS"
}
}
}
deletePaymentToken
Description
Delete a customer's payment token.
Response
Returns a DeletePaymentTokenOutput
Arguments
| Name | Description |
|---|---|
public_hash - String!
|
The reusable payment token securely stored in the vault. |
Example
Query
mutation deletePaymentToken($public_hash: String!) {
deletePaymentToken(public_hash: $public_hash) {
customerPaymentTokens {
...CustomerPaymentTokensFragment
}
result
}
}
Variables
{"public_hash": "xyz789"}
Response
{
"data": {
"deletePaymentToken": {
"customerPaymentTokens": CustomerPaymentTokens,
"result": true
}
}
}
deletePurchaseOrderApprovalRule
Description
Delete existing purchase order approval rules.
Response
Returns a DeletePurchaseOrderApprovalRuleOutput
Arguments
| Name | Description |
|---|---|
input - DeletePurchaseOrderApprovalRuleInput!
|
Example
Query
mutation deletePurchaseOrderApprovalRule($input: DeletePurchaseOrderApprovalRuleInput!) {
deletePurchaseOrderApprovalRule(input: $input) {
errors {
...DeletePurchaseOrderApprovalRuleErrorFragment
}
}
}
Variables
{"input": DeletePurchaseOrderApprovalRuleInput}
Response
{
"data": {
"deletePurchaseOrderApprovalRule": {
"errors": [DeletePurchaseOrderApprovalRuleError]
}
}
}
deleteRequisitionList
Description
Delete a requisition list.
Response
Returns a DeleteRequisitionListOutput
Arguments
| Name | Description |
|---|---|
requisitionListUid - ID!
|
The unique ID of the requisition list. |
Example
Query
mutation deleteRequisitionList($requisitionListUid: ID!) {
deleteRequisitionList(requisitionListUid: $requisitionListUid) {
requisition_lists {
...RequisitionListsFragment
}
status
}
}
Variables
{"requisitionListUid": "4"}
Response
{
"data": {
"deleteRequisitionList": {
"requisition_lists": RequisitionLists,
"status": false
}
}
}
deleteRequisitionListItems
Description
Delete items from a requisition list.
Response
Returns a DeleteRequisitionListItemsOutput
Example
Query
mutation deleteRequisitionListItems(
$requisitionListUid: ID!,
$requisitionListItemUids: [ID!]!
) {
deleteRequisitionListItems(
requisitionListUid: $requisitionListUid,
requisitionListItemUids: $requisitionListItemUids
) {
requisition_list {
...RequisitionListFragment
}
}
}
Variables
{"requisitionListUid": 4, "requisitionListItemUids": [4]}
Response
{
"data": {
"deleteRequisitionListItems": {
"requisition_list": RequisitionList
}
}
}
deleteWishlist
Description
Delete the specified wish list. You cannot delete the customer's default (first) wish list.
Response
Returns a DeleteWishlistOutput
Arguments
| Name | Description |
|---|---|
wishlistId - ID!
|
The ID of the wish list to delete. |
Example
Query
mutation deleteWishlist($wishlistId: ID!) {
deleteWishlist(wishlistId: $wishlistId) {
status
wishlists {
...WishlistFragment
}
}
}
Variables
{"wishlistId": "4"}
Response
{
"data": {
"deleteWishlist": {
"status": true,
"wishlists": [Wishlist]
}
}
}
estimateShippingMethods
Description
Estimate shipping method(s) for cart based on address
Response
Returns [AvailableShippingMethod]
Arguments
| Name | Description |
|---|---|
input - EstimateTotalsInput!
|
An input object that specifies details for estimation of available shipping methods |
Example
Query
mutation estimateShippingMethods($input: EstimateTotalsInput!) {
estimateShippingMethods(input: $input) {
amount {
...MoneyFragment
}
available
base_amount {
...MoneyFragment
}
carrier_code
carrier_title
error_message
method_code
method_title
price_excl_tax {
...MoneyFragment
}
price_incl_tax {
...MoneyFragment
}
}
}
Variables
{"input": EstimateTotalsInput}
Response
{
"data": {
"estimateShippingMethods": [
{
"amount": Money,
"available": false,
"base_amount": Money,
"carrier_code": "xyz789",
"carrier_title": "abc123",
"error_message": "abc123",
"method_code": "abc123",
"method_title": "xyz789",
"price_excl_tax": Money,
"price_incl_tax": Money
}
]
}
}
estimateTotals
Description
Estimate totals for cart based on the address
Response
Returns an EstimateTotalsOutput!
Arguments
| Name | Description |
|---|---|
input - EstimateTotalsInput!
|
An input object that specifies details for cart totals estimation |
Example
Query
mutation estimateTotals($input: EstimateTotalsInput!) {
estimateTotals(input: $input) {
cart {
...CartFragment
}
}
}
Variables
{"input": EstimateTotalsInput}
Response
{"data": {"estimateTotals": {"cart": Cart}}}
generateCustomerToken
Description
Generate a token for specified customer.
Response
Returns a CustomerToken
Example
Query
mutation generateCustomerToken(
$email: String!,
$password: String!
) {
generateCustomerToken(
email: $email,
password: $password
) {
token
}
}
Variables
{
"email": "xyz789",
"password": "xyz789"
}
Response
{
"data": {
"generateCustomerToken": {
"token": "abc123"
}
}
}
generateCustomerTokenAsAdmin
Description
Request a customer token so that an administrator can perform remote shopping assistance.
Response
Returns a GenerateCustomerTokenAsAdminOutput
Arguments
| Name | Description |
|---|---|
input - GenerateCustomerTokenAsAdminInput!
|
An input object that defines the customer email address. |
Example
Query
mutation generateCustomerTokenAsAdmin($input: GenerateCustomerTokenAsAdminInput!) {
generateCustomerTokenAsAdmin(input: $input) {
customer_token
}
}
Variables
{"input": GenerateCustomerTokenAsAdminInput}
Response
{
"data": {
"generateCustomerTokenAsAdmin": {
"customer_token": "xyz789"
}
}
}
handlePayflowProResponse
Description
Handle a payment response and save the payment in Quote. Use this mutation for Payflow Pro and Payments Pro payment methods.
Response
Returns a PayflowProResponseOutput
Arguments
| Name | Description |
|---|---|
input - PayflowProResponseInput!
|
An input object that includes the payload returned by PayPal and the cart ID. |
Example
Query
mutation handlePayflowProResponse($input: PayflowProResponseInput!) {
handlePayflowProResponse(input: $input) {
cart {
...CartFragment
}
}
}
Variables
{"input": PayflowProResponseInput}
Response
{"data": {"handlePayflowProResponse": {"cart": Cart}}}
mergeCarts
Description
Transfer the contents of a guest cart into the cart of a logged-in customer.
Response
Returns a Cart!
Example
Query
mutation mergeCarts(
$source_cart_id: String!,
$destination_cart_id: String
) {
mergeCarts(
source_cart_id: $source_cart_id,
destination_cart_id: $destination_cart_id
) {
applied_coupon {
...AppliedCouponFragment
}
applied_coupons {
...AppliedCouponFragment
}
applied_gift_cards {
...AppliedGiftCardFragment
}
applied_reward_points {
...RewardPointsAmountFragment
}
applied_store_credit {
...AppliedStoreCreditFragment
}
available_gift_wrappings {
...GiftWrappingFragment
}
available_payment_methods {
...AvailablePaymentMethodFragment
}
billing_address {
...BillingCartAddressFragment
}
email
gift_message {
...GiftMessageFragment
}
gift_receipt_included
gift_wrapping {
...GiftWrappingFragment
}
id
is_virtual
items {
...CartItemInterfaceFragment
}
itemsV2 {
...CartItemsFragment
}
prices {
...CartPricesFragment
}
printed_card_included
selected_payment_method {
...SelectedPaymentMethodFragment
}
shipping_addresses {
...ShippingCartAddressFragment
}
total_quantity
}
}
Variables
{
"source_cart_id": "xyz789",
"destination_cart_id": "abc123"
}
Response
{
"data": {
"mergeCarts": {
"applied_coupon": AppliedCoupon,
"applied_coupons": [AppliedCoupon],
"applied_gift_cards": [AppliedGiftCard],
"applied_reward_points": RewardPointsAmount,
"applied_store_credit": AppliedStoreCredit,
"available_gift_wrappings": [GiftWrapping],
"available_payment_methods": [
AvailablePaymentMethod
],
"billing_address": BillingCartAddress,
"email": "xyz789",
"gift_message": GiftMessage,
"gift_receipt_included": false,
"gift_wrapping": GiftWrapping,
"id": "4",
"is_virtual": true,
"items": [CartItemInterface],
"itemsV2": CartItems,
"prices": CartPrices,
"printed_card_included": false,
"selected_payment_method": SelectedPaymentMethod,
"shipping_addresses": [ShippingCartAddress],
"total_quantity": 987.65
}
}
}
moveCartItemsToGiftRegistry
Description
Move all items from the cart to a gift registry.
Response
Returns a MoveCartItemsToGiftRegistryOutput
Example
Query
mutation moveCartItemsToGiftRegistry(
$cartUid: ID!,
$giftRegistryUid: ID!
) {
moveCartItemsToGiftRegistry(
cartUid: $cartUid,
giftRegistryUid: $giftRegistryUid
) {
gift_registry {
...GiftRegistryFragment
}
status
user_errors {
...GiftRegistryItemsUserErrorFragment
}
}
}
Variables
{"cartUid": "4", "giftRegistryUid": 4}
Response
{
"data": {
"moveCartItemsToGiftRegistry": {
"gift_registry": GiftRegistry,
"status": false,
"user_errors": [GiftRegistryItemsUserError]
}
}
}
moveItemsBetweenRequisitionLists
Description
Move Items from one requisition list to another.
Response
Returns a MoveItemsBetweenRequisitionListsOutput
Arguments
| Name | Description |
|---|---|
sourceRequisitionListUid - ID!
|
The unique ID of the source requisition list. |
destinationRequisitionListUid - ID
|
The unique ID of the destination requisition list. If null, a new requisition list will be created. |
requisitionListItem - MoveItemsBetweenRequisitionListsInput
|
The list of products to move. |
Example
Query
mutation moveItemsBetweenRequisitionLists(
$sourceRequisitionListUid: ID!,
$destinationRequisitionListUid: ID,
$requisitionListItem: MoveItemsBetweenRequisitionListsInput
) {
moveItemsBetweenRequisitionLists(
sourceRequisitionListUid: $sourceRequisitionListUid,
destinationRequisitionListUid: $destinationRequisitionListUid,
requisitionListItem: $requisitionListItem
) {
destination_requisition_list {
...RequisitionListFragment
}
source_requisition_list {
...RequisitionListFragment
}
}
}
Variables
{
"sourceRequisitionListUid": 4,
"destinationRequisitionListUid": "4",
"requisitionListItem": MoveItemsBetweenRequisitionListsInput
}
Response
{
"data": {
"moveItemsBetweenRequisitionLists": {
"destination_requisition_list": RequisitionList,
"source_requisition_list": RequisitionList
}
}
}
moveProductsBetweenWishlists
Description
Move products from one wish list to another.
Response
Returns a MoveProductsBetweenWishlistsOutput
Arguments
| Name | Description |
|---|---|
sourceWishlistUid - ID!
|
The ID of the original wish list. |
destinationWishlistUid - ID!
|
The ID of the target wish list. |
wishlistItems - [WishlistItemMoveInput!]!
|
An array of items to move. |
Example
Query
mutation moveProductsBetweenWishlists(
$sourceWishlistUid: ID!,
$destinationWishlistUid: ID!,
$wishlistItems: [WishlistItemMoveInput!]!
) {
moveProductsBetweenWishlists(
sourceWishlistUid: $sourceWishlistUid,
destinationWishlistUid: $destinationWishlistUid,
wishlistItems: $wishlistItems
) {
destination_wishlist {
...WishlistFragment
}
source_wishlist {
...WishlistFragment
}
user_errors {
...WishListUserInputErrorFragment
}
}
}
Variables
{
"sourceWishlistUid": 4,
"destinationWishlistUid": 4,
"wishlistItems": [WishlistItemMoveInput]
}
Response
{
"data": {
"moveProductsBetweenWishlists": {
"destination_wishlist": Wishlist,
"source_wishlist": Wishlist,
"user_errors": [WishListUserInputError]
}
}
}
placeNegotiableQuoteOrder
Description
Convert a negotiable quote into an order.
Response
Returns a PlaceNegotiableQuoteOrderOutput
Arguments
| Name | Description |
|---|---|
input - PlaceNegotiableQuoteOrderInput!
|
An input object that specifies the negotiable quote. |
Example
Query
mutation placeNegotiableQuoteOrder($input: PlaceNegotiableQuoteOrderInput!) {
placeNegotiableQuoteOrder(input: $input) {
order {
...OrderFragment
}
}
}
Variables
{"input": PlaceNegotiableQuoteOrderInput}
Response
{"data": {"placeNegotiableQuoteOrder": {"order": Order}}}
placeOrder
Description
Convert the quote into an order.
Response
Returns a PlaceOrderOutput
Arguments
| Name | Description |
|---|---|
input - PlaceOrderInput
|
An input object that defines the shopper's cart ID. |
Example
Query
mutation placeOrder($input: PlaceOrderInput) {
placeOrder(input: $input) {
errors {
...PlaceOrderErrorFragment
}
order {
...OrderFragment
}
orderV2 {
...CustomerOrderFragment
}
}
}
Variables
{"input": PlaceOrderInput}
Response
{
"data": {
"placeOrder": {
"errors": [PlaceOrderError],
"order": Order,
"orderV2": CustomerOrder
}
}
}
placeOrderForPurchaseOrder
Description
Convert the purchase order into an order.
Response
Returns a PlaceOrderForPurchaseOrderOutput
Arguments
| Name | Description |
|---|---|
input - PlaceOrderForPurchaseOrderInput!
|
Example
Query
mutation placeOrderForPurchaseOrder($input: PlaceOrderForPurchaseOrderInput!) {
placeOrderForPurchaseOrder(input: $input) {
order {
...CustomerOrderFragment
}
}
}
Variables
{"input": PlaceOrderForPurchaseOrderInput}
Response
{
"data": {
"placeOrderForPurchaseOrder": {"order": CustomerOrder}
}
}
placePurchaseOrder
Description
Place a purchase order.
Response
Returns a PlacePurchaseOrderOutput
Arguments
| Name | Description |
|---|---|
input - PlacePurchaseOrderInput!
|
Example
Query
mutation placePurchaseOrder($input: PlacePurchaseOrderInput!) {
placePurchaseOrder(input: $input) {
purchase_order {
...PurchaseOrderFragment
}
}
}
Variables
{"input": PlacePurchaseOrderInput}
Response
{
"data": {
"placePurchaseOrder": {
"purchase_order": PurchaseOrder
}
}
}
redeemGiftCardBalanceAsStoreCredit
Description
Redeem a gift card for store credit.
Response
Returns a GiftCardAccount
Arguments
| Name | Description |
|---|---|
input - GiftCardAccountInput!
|
An input object that specifies the gift card code to redeem. |
Example
Query
mutation redeemGiftCardBalanceAsStoreCredit($input: GiftCardAccountInput!) {
redeemGiftCardBalanceAsStoreCredit(input: $input) {
balance {
...MoneyFragment
}
code
expiration_date
}
}
Variables
{"input": GiftCardAccountInput}
Response
{
"data": {
"redeemGiftCardBalanceAsStoreCredit": {
"balance": Money,
"code": "abc123",
"expiration_date": "abc123"
}
}
}
rejectPurchaseOrders
Description
Reject purchase orders.
Response
Returns a PurchaseOrdersActionOutput
Arguments
| Name | Description |
|---|---|
input - PurchaseOrdersActionInput!
|
Example
Query
mutation rejectPurchaseOrders($input: PurchaseOrdersActionInput!) {
rejectPurchaseOrders(input: $input) {
errors {
...PurchaseOrderActionErrorFragment
}
purchase_orders {
...PurchaseOrderFragment
}
}
}
Variables
{"input": PurchaseOrdersActionInput}
Response
{
"data": {
"rejectPurchaseOrders": {
"errors": [PurchaseOrderActionError],
"purchase_orders": [PurchaseOrder]
}
}
}
removeCouponFromCart
Description
Remove a previously-applied coupon from the cart. The cart must contain at least one item in order to remove the coupon.
Response
Returns a RemoveCouponFromCartOutput
Arguments
| Name | Description |
|---|---|
input - RemoveCouponFromCartInput
|
An input object that defines which coupon code to remove from the cart. |
Example
Query
mutation removeCouponFromCart($input: RemoveCouponFromCartInput) {
removeCouponFromCart(input: $input) {
cart {
...CartFragment
}
}
}
Variables
{"input": RemoveCouponFromCartInput}
Response
{"data": {"removeCouponFromCart": {"cart": Cart}}}
removeCouponsFromCart
Description
Remove a previously-applied coupon from the cart. The cart must contain at least one item in order to remove the coupon.
Response
Returns a RemoveCouponFromCartOutput
Arguments
| Name | Description |
|---|---|
input - RemoveCouponsFromCartInput
|
An input object that defines which coupon code to remove from the cart. |
Example
Query
mutation removeCouponsFromCart($input: RemoveCouponsFromCartInput) {
removeCouponsFromCart(input: $input) {
cart {
...CartFragment
}
}
}
Variables
{"input": RemoveCouponsFromCartInput}
Response
{"data": {"removeCouponsFromCart": {"cart": Cart}}}
removeGiftCardFromCart
Description
Removes a gift card from the cart.
Response
Returns a RemoveGiftCardFromCartOutput
Arguments
| Name | Description |
|---|---|
input - RemoveGiftCardFromCartInput
|
An input object that specifies which gift card code to remove from the cart. |
Example
Query
mutation removeGiftCardFromCart($input: RemoveGiftCardFromCartInput) {
removeGiftCardFromCart(input: $input) {
cart {
...CartFragment
}
}
}
Variables
{"input": RemoveGiftCardFromCartInput}
Response
{"data": {"removeGiftCardFromCart": {"cart": Cart}}}
removeGiftRegistry
Description
Delete the specified gift registry.
Response
Returns a RemoveGiftRegistryOutput
Arguments
| Name | Description |
|---|---|
giftRegistryUid - ID!
|
The unique ID of the gift registry to delete. |
Example
Query
mutation removeGiftRegistry($giftRegistryUid: ID!) {
removeGiftRegistry(giftRegistryUid: $giftRegistryUid) {
success
}
}
Variables
{"giftRegistryUid": 4}
Response
{"data": {"removeGiftRegistry": {"success": true}}}
removeGiftRegistryItems
Description
Delete the specified items from a gift registry.
Response
Returns a RemoveGiftRegistryItemsOutput
Example
Query
mutation removeGiftRegistryItems(
$giftRegistryUid: ID!,
$itemsUid: [ID!]!
) {
removeGiftRegistryItems(
giftRegistryUid: $giftRegistryUid,
itemsUid: $itemsUid
) {
gift_registry {
...GiftRegistryFragment
}
}
}
Variables
{"giftRegistryUid": 4, "itemsUid": ["4"]}
Response
{
"data": {
"removeGiftRegistryItems": {
"gift_registry": GiftRegistry
}
}
}
removeGiftRegistryRegistrants
Description
Removes registrants from a gift registry.
Response
Returns a RemoveGiftRegistryRegistrantsOutput
Example
Query
mutation removeGiftRegistryRegistrants(
$giftRegistryUid: ID!,
$registrantsUid: [ID!]!
) {
removeGiftRegistryRegistrants(
giftRegistryUid: $giftRegistryUid,
registrantsUid: $registrantsUid
) {
gift_registry {
...GiftRegistryFragment
}
}
}
Variables
{
"giftRegistryUid": "4",
"registrantsUid": [4]
}
Response
{
"data": {
"removeGiftRegistryRegistrants": {
"gift_registry": GiftRegistry
}
}
}
removeItemFromCart
Description
Delete the entire quantity of a specified item from the cart. If you remove all items from the cart, the cart continues to exist.
Response
Returns a RemoveItemFromCartOutput
Arguments
| Name | Description |
|---|---|
input - RemoveItemFromCartInput
|
An input object that defines which products to remove from the cart. |
Example
Query
mutation removeItemFromCart($input: RemoveItemFromCartInput) {
removeItemFromCart(input: $input) {
cart {
...CartFragment
}
}
}
Variables
{"input": RemoveItemFromCartInput}
Response
{"data": {"removeItemFromCart": {"cart": Cart}}}
removeNegotiableQuoteItems
Description
Remove one or more products from a negotiable quote.
Response
Returns a RemoveNegotiableQuoteItemsOutput
Arguments
| Name | Description |
|---|---|
input - RemoveNegotiableQuoteItemsInput!
|
An input object that removes one or more items from a negotiable quote. |
Example
Query
mutation removeNegotiableQuoteItems($input: RemoveNegotiableQuoteItemsInput!) {
removeNegotiableQuoteItems(input: $input) {
quote {
...NegotiableQuoteFragment
}
}
}
Variables
{"input": RemoveNegotiableQuoteItemsInput}
Response
{
"data": {
"removeNegotiableQuoteItems": {
"quote": NegotiableQuote
}
}
}
removeProductsFromCompareList
Description
Remove products from the specified compare list.
Response
Returns a CompareList
Arguments
| Name | Description |
|---|---|
input - RemoveProductsFromCompareListInput
|
An input object that defines which products to remove from a compare list. |
Example
Query
mutation removeProductsFromCompareList($input: RemoveProductsFromCompareListInput) {
removeProductsFromCompareList(input: $input) {
attributes {
...ComparableAttributeFragment
}
item_count
items {
...ComparableItemFragment
}
uid
}
}
Variables
{"input": RemoveProductsFromCompareListInput}
Response
{
"data": {
"removeProductsFromCompareList": {
"attributes": [ComparableAttribute],
"item_count": 123,
"items": [ComparableItem],
"uid": 4
}
}
}
removeProductsFromWishlist
Description
Remove one or more products from the specified wish list.
Response
Returns a RemoveProductsFromWishlistOutput
Example
Query
mutation removeProductsFromWishlist(
$wishlistId: ID!,
$wishlistItemsIds: [ID!]!
) {
removeProductsFromWishlist(
wishlistId: $wishlistId,
wishlistItemsIds: $wishlistItemsIds
) {
user_errors {
...WishListUserInputErrorFragment
}
wishlist {
...WishlistFragment
}
}
}
Variables
{"wishlistId": 4, "wishlistItemsIds": [4]}
Response
{
"data": {
"removeProductsFromWishlist": {
"user_errors": [WishListUserInputError],
"wishlist": Wishlist
}
}
}
removeReturnTracking
Description
Remove a tracked shipment from a return.
Response
Returns a RemoveReturnTrackingOutput
Arguments
| Name | Description |
|---|---|
input - RemoveReturnTrackingInput!
|
An input object that removes tracking information. |
Example
Query
mutation removeReturnTracking($input: RemoveReturnTrackingInput!) {
removeReturnTracking(input: $input) {
return {
...ReturnFragment
}
}
}
Variables
{"input": RemoveReturnTrackingInput}
Response
{"data": {"removeReturnTracking": {"return": Return}}}
removeRewardPointsFromCart
Description
Cancel the application of reward points to the cart.
Response
Returns a RemoveRewardPointsFromCartOutput
Arguments
| Name | Description |
|---|---|
cartId - ID!
|
Example
Query
mutation removeRewardPointsFromCart($cartId: ID!) {
removeRewardPointsFromCart(cartId: $cartId) {
cart {
...CartFragment
}
}
}
Variables
{"cartId": "4"}
Response
{"data": {"removeRewardPointsFromCart": {"cart": Cart}}}
removeStoreCreditFromCart
Description
Remove store credit that has been applied to the specified cart.
Response
Returns a RemoveStoreCreditFromCartOutput
Arguments
| Name | Description |
|---|---|
input - RemoveStoreCreditFromCartInput!
|
An input object that specifies the cart ID. |
Example
Query
mutation removeStoreCreditFromCart($input: RemoveStoreCreditFromCartInput!) {
removeStoreCreditFromCart(input: $input) {
cart {
...CartFragment
}
}
}
Variables
{"input": RemoveStoreCreditFromCartInput}
Response
{"data": {"removeStoreCreditFromCart": {"cart": Cart}}}
reorderItems
Description
Add all products from a customer's previous order to the cart.
Response
Returns a ReorderItemsOutput
Arguments
| Name | Description |
|---|---|
orderNumber - String!
|
Example
Query
mutation reorderItems($orderNumber: String!) {
reorderItems(orderNumber: $orderNumber) {
cart {
...CartFragment
}
userInputErrors {
...CheckoutUserInputErrorFragment
}
}
}
Variables
{"orderNumber": "abc123"}
Response
{
"data": {
"reorderItems": {
"cart": Cart,
"userInputErrors": [CheckoutUserInputError]
}
}
}
requestNegotiableQuote
Description
Request a new negotiable quote on behalf of the buyer.
Response
Returns a RequestNegotiableQuoteOutput
Arguments
| Name | Description |
|---|---|
input - RequestNegotiableQuoteInput!
|
An input object that contains a request to initiate a negotiable quote. |
Example
Query
mutation requestNegotiableQuote($input: RequestNegotiableQuoteInput!) {
requestNegotiableQuote(input: $input) {
quote {
...NegotiableQuoteFragment
}
}
}
Variables
{"input": RequestNegotiableQuoteInput}
Response
{
"data": {
"requestNegotiableQuote": {"quote": NegotiableQuote}
}
}
requestPasswordResetEmail
Description
Request an email with a reset password token for the registered customer identified by the specified email.
requestReturn
Description
Initiates a buyer's request to return items for replacement or refund.
Response
Returns a RequestReturnOutput
Arguments
| Name | Description |
|---|---|
input - RequestReturnInput!
|
An input object that contains the fields needed to start a return request. |
Example
Query
mutation requestReturn($input: RequestReturnInput!) {
requestReturn(input: $input) {
return {
...ReturnFragment
}
returns {
...ReturnsFragment
}
}
}
Variables
{"input": RequestReturnInput}
Response
{
"data": {
"requestReturn": {
"return": Return,
"returns": Returns
}
}
}
resetPassword
Description
Reset a customer's password using the reset password token that the customer received in an email after requesting it using requestPasswordResetEmail.
Response
Returns a Boolean
Example
Query
mutation resetPassword(
$email: String!,
$resetPasswordToken: String!,
$newPassword: String!
) {
resetPassword(
email: $email,
resetPasswordToken: $resetPasswordToken,
newPassword: $newPassword
)
}
Variables
{
"email": "abc123",
"resetPasswordToken": "abc123",
"newPassword": "xyz789"
}
Response
{"data": {"resetPassword": false}}
revokeCustomerToken
Description
Revoke the customer token.
Response
Returns a RevokeCustomerTokenOutput
Example
Query
mutation revokeCustomerToken {
revokeCustomerToken {
result
}
}
Response
{"data": {"revokeCustomerToken": {"result": false}}}
sendEmailToFriend
Description
Send a message on behalf of a customer to the specified email addresses.
Response
Returns a SendEmailToFriendOutput
Arguments
| Name | Description |
|---|---|
input - SendEmailToFriendInput
|
An input object that defines sender, recipients, and product. |
Example
Query
mutation sendEmailToFriend($input: SendEmailToFriendInput) {
sendEmailToFriend(input: $input) {
recipients {
...SendEmailToFriendRecipientFragment
}
sender {
...SendEmailToFriendSenderFragment
}
}
}
Variables
{"input": SendEmailToFriendInput}
Response
{
"data": {
"sendEmailToFriend": {
"recipients": [SendEmailToFriendRecipient],
"sender": SendEmailToFriendSender
}
}
}
sendNegotiableQuoteForReview
Description
Send the negotiable quote to the seller for review.
Response
Returns a SendNegotiableQuoteForReviewOutput
Arguments
| Name | Description |
|---|---|
input - SendNegotiableQuoteForReviewInput!
|
An input object that sends a request for the merchant to review a negotiable quote. |
Example
Query
mutation sendNegotiableQuoteForReview($input: SendNegotiableQuoteForReviewInput!) {
sendNegotiableQuoteForReview(input: $input) {
quote {
...NegotiableQuoteFragment
}
}
}
Variables
{"input": SendNegotiableQuoteForReviewInput}
Response
{
"data": {
"sendNegotiableQuoteForReview": {
"quote": NegotiableQuote
}
}
}
setBillingAddressOnCart
Description
Set the billing address on a specific cart.
Response
Returns a SetBillingAddressOnCartOutput
Arguments
| Name | Description |
|---|---|
input - SetBillingAddressOnCartInput
|
An input object that defines the billing address to be assigned to the cart. |
Example
Query
mutation setBillingAddressOnCart($input: SetBillingAddressOnCartInput) {
setBillingAddressOnCart(input: $input) {
cart {
...CartFragment
}
}
}
Variables
{"input": SetBillingAddressOnCartInput}
Response
{"data": {"setBillingAddressOnCart": {"cart": Cart}}}
setGiftOptionsOnCart
Description
Set gift options, including gift messages, gift wrapping, gift receipts, and printed cards.
Response
Returns a SetGiftOptionsOnCartOutput
Arguments
| Name | Description |
|---|---|
input - SetGiftOptionsOnCartInput
|
An input object that defines the selected gift options. |
Example
Query
mutation setGiftOptionsOnCart($input: SetGiftOptionsOnCartInput) {
setGiftOptionsOnCart(input: $input) {
cart {
...CartFragment
}
}
}
Variables
{"input": SetGiftOptionsOnCartInput}
Response
{"data": {"setGiftOptionsOnCart": {"cart": Cart}}}
setGuestEmailOnCart
Description
Assign the email address of a guest to the cart.
Response
Returns a SetGuestEmailOnCartOutput
Arguments
| Name | Description |
|---|---|
input - SetGuestEmailOnCartInput
|
An input object that defines a guest email address. |
Example
Query
mutation setGuestEmailOnCart($input: SetGuestEmailOnCartInput) {
setGuestEmailOnCart(input: $input) {
cart {
...CartFragment
}
}
}
Variables
{"input": SetGuestEmailOnCartInput}
Response
{"data": {"setGuestEmailOnCart": {"cart": Cart}}}
setLineItemNote
Description
Add buyer's note to a negotiable quote item.
Response
Returns a SetLineItemNoteOutput
Arguments
| Name | Description |
|---|---|
input - LineItemNoteInput!
|
An input object that defines the quote item note. |
Example
Query
mutation setLineItemNote($input: LineItemNoteInput!) {
setLineItemNote(input: $input) {
quote {
...NegotiableQuoteFragment
}
}
}
Variables
{"input": LineItemNoteInput}
Response
{"data": {"setLineItemNote": {"quote": NegotiableQuote}}}
setNegotiableQuoteBillingAddress
Description
Assign a billing address to a negotiable quote.
Response
Returns a SetNegotiableQuoteBillingAddressOutput
Arguments
| Name | Description |
|---|---|
input - SetNegotiableQuoteBillingAddressInput!
|
An input object that defines the billing address to be assigned to a negotiable quote. |
Example
Query
mutation setNegotiableQuoteBillingAddress($input: SetNegotiableQuoteBillingAddressInput!) {
setNegotiableQuoteBillingAddress(input: $input) {
quote {
...NegotiableQuoteFragment
}
}
}
Variables
{"input": SetNegotiableQuoteBillingAddressInput}
Response
{
"data": {
"setNegotiableQuoteBillingAddress": {
"quote": NegotiableQuote
}
}
}
setNegotiableQuotePaymentMethod
Description
Set the payment method on a negotiable quote.
Response
Returns a SetNegotiableQuotePaymentMethodOutput
Arguments
| Name | Description |
|---|---|
input - SetNegotiableQuotePaymentMethodInput!
|
An input object that defines the payment method for the specified negotiable quote. |
Example
Query
mutation setNegotiableQuotePaymentMethod($input: SetNegotiableQuotePaymentMethodInput!) {
setNegotiableQuotePaymentMethod(input: $input) {
quote {
...NegotiableQuoteFragment
}
}
}
Variables
{"input": SetNegotiableQuotePaymentMethodInput}
Response
{
"data": {
"setNegotiableQuotePaymentMethod": {
"quote": NegotiableQuote
}
}
}
setNegotiableQuoteShippingAddress
Description
Assign a previously-defined address as the shipping address for a negotiable quote.
Response
Returns a SetNegotiableQuoteShippingAddressOutput
Arguments
| Name | Description |
|---|---|
input - SetNegotiableQuoteShippingAddressInput!
|
An input object that defines the shipping address to be assigned to a negotiable quote. |
Example
Query
mutation setNegotiableQuoteShippingAddress($input: SetNegotiableQuoteShippingAddressInput!) {
setNegotiableQuoteShippingAddress(input: $input) {
quote {
...NegotiableQuoteFragment
}
}
}
Variables
{"input": SetNegotiableQuoteShippingAddressInput}
Response
{
"data": {
"setNegotiableQuoteShippingAddress": {
"quote": NegotiableQuote
}
}
}