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 endpoint

https://<your-store>/graphql

Headers

For header information, refer to GraphQL headers.

Version

2.4.9

Queries

attributesForm

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: 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

Returns a list of attributes metadata for a given entity type.

Response: 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

Get a list of available store views and their config information.

Response: [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_merge_preference
    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_product_image
    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_product_prices_in_catalog
    display_shipping_prices
    display_state_if_optional
    enable_multiple_wishlists
    fixed_product_taxes_apply_tax_to_fpt
    fixed_product_taxes_display_prices_in_emails
    fixed_product_taxes_display_prices_in_product_lists
    fixed_product_taxes_display_prices_in_sales_modules
    fixed_product_taxes_display_prices_on_product_view_page
    fixed_product_taxes_enable
    fixed_product_taxes_include_fpt_in_subtotal
    front
    graphql_share_customer_group
    grid_per_page
    grid_per_page_values
    grouped_product_image
    head_includes
    head_shortcut_icon
    header_logo_src
    id
    is_checkout_agreements_enabled
    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
    }
    orders_invoices_credit_memos_display_full_summary
    orders_invoices_credit_memos_display_grandtotal
    orders_invoices_credit_memos_display_price
    orders_invoices_credit_memos_display_shipping_amount
    orders_invoices_credit_memos_display_subtotal
    orders_invoices_credit_memos_display_zero_tax
    payment_payflowpro_cc_vault_active
    printed_card_price
    printed_card_priceV2 {
      ...MoneyFragment
    }
    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
    }
    share_active_segments
    share_applied_cart_rule
    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": true}
Response
{
  "data": {
    "availableStores": [
      {
        "absolute_footer": "abc123",
        "allow_gift_receipt": "abc123",
        "allow_gift_wrapping_on_order": "abc123",
        "allow_gift_wrapping_on_order_items": "xyz789",
        "allow_guests_to_write_product_reviews": "xyz789",
        "allow_items": "xyz789",
        "allow_order": "abc123",
        "allow_printed_card": "abc123",
        "autocomplete_on_storefront": false,
        "base_currency_code": "xyz789",
        "base_link_url": "abc123",
        "base_media_url": "abc123",
        "base_static_url": "xyz789",
        "base_url": "abc123",
        "braintree_3dsecure_allowspecific": true,
        "braintree_3dsecure_always_request_3ds": false,
        "braintree_3dsecure_specificcountry": "xyz789",
        "braintree_3dsecure_threshold_amount": "abc123",
        "braintree_3dsecure_verify_3dsecure": true,
        "braintree_ach_direct_debit_vault_active": false,
        "braintree_applepay_merchant_name": "xyz789",
        "braintree_applepay_vault_active": true,
        "braintree_cc_vault_active": "abc123",
        "braintree_cc_vault_cvv": true,
        "braintree_environment": "abc123",
        "braintree_googlepay_btn_color": "abc123",
        "braintree_googlepay_cctypes": "xyz789",
        "braintree_googlepay_merchant_id": "abc123",
        "braintree_googlepay_vault_active": true,
        "braintree_local_payment_allowed_methods": "abc123",
        "braintree_local_payment_fallback_button_text": "xyz789",
        "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": "xyz789",
        "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": false,
        "braintree_paypal_button_location_cart_type_messaging_text_color": "abc123",
        "braintree_paypal_button_location_cart_type_paylater_color": "abc123",
        "braintree_paypal_button_location_cart_type_paylater_label": "abc123",
        "braintree_paypal_button_location_cart_type_paylater_shape": "xyz789",
        "braintree_paypal_button_location_cart_type_paylater_show": true,
        "braintree_paypal_button_location_cart_type_paypal_color": "xyz789",
        "braintree_paypal_button_location_cart_type_paypal_label": "abc123",
        "braintree_paypal_button_location_cart_type_paypal_shape": "xyz789",
        "braintree_paypal_button_location_cart_type_paypal_show": true,
        "braintree_paypal_button_location_checkout_type_credit_color": "xyz789",
        "braintree_paypal_button_location_checkout_type_credit_label": "xyz789",
        "braintree_paypal_button_location_checkout_type_credit_shape": "xyz789",
        "braintree_paypal_button_location_checkout_type_credit_show": false,
        "braintree_paypal_button_location_checkout_type_messaging_layout": "xyz789",
        "braintree_paypal_button_location_checkout_type_messaging_logo": "xyz789",
        "braintree_paypal_button_location_checkout_type_messaging_logo_position": "abc123",
        "braintree_paypal_button_location_checkout_type_messaging_show": true,
        "braintree_paypal_button_location_checkout_type_messaging_text_color": "xyz789",
        "braintree_paypal_button_location_checkout_type_paylater_color": "abc123",
        "braintree_paypal_button_location_checkout_type_paylater_label": "xyz789",
        "braintree_paypal_button_location_checkout_type_paylater_shape": "abc123",
        "braintree_paypal_button_location_checkout_type_paylater_show": true,
        "braintree_paypal_button_location_checkout_type_paypal_color": "abc123",
        "braintree_paypal_button_location_checkout_type_paypal_label": "abc123",
        "braintree_paypal_button_location_checkout_type_paypal_shape": "abc123",
        "braintree_paypal_button_location_checkout_type_paypal_show": true,
        "braintree_paypal_button_location_productpage_type_credit_color": "abc123",
        "braintree_paypal_button_location_productpage_type_credit_label": "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": false,
        "braintree_paypal_button_location_productpage_type_messaging_text_color": "abc123",
        "braintree_paypal_button_location_productpage_type_paylater_color": "xyz789",
        "braintree_paypal_button_location_productpage_type_paylater_label": "xyz789",
        "braintree_paypal_button_location_productpage_type_paylater_shape": "xyz789",
        "braintree_paypal_button_location_productpage_type_paylater_show": false,
        "braintree_paypal_button_location_productpage_type_paypal_color": "xyz789",
        "braintree_paypal_button_location_productpage_type_paypal_label": "abc123",
        "braintree_paypal_button_location_productpage_type_paypal_shape": "xyz789",
        "braintree_paypal_button_location_productpage_type_paypal_show": false,
        "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": 987,
        "cart_gift_wrapping": "abc123",
        "cart_merge_preference": "xyz789",
        "cart_printed_card": "abc123",
        "cart_summary_display_quantity": 987,
        "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": "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": "abc123",
        "check_money_order_sort_order": 123,
        "check_money_order_title": "xyz789",
        "cms_home_page": "xyz789",
        "cms_no_cookies": "xyz789",
        "cms_no_route": "xyz789",
        "code": "abc123",
        "configurable_product_image": "ITSELF",
        "configurable_thumbnail_source": "xyz789",
        "contact_enabled": false,
        "copyright": "abc123",
        "countries_with_required_region": "abc123",
        "create_account_confirmation": true,
        "customer_access_token_lifetime": 987.65,
        "default_country": "abc123",
        "default_description": "abc123",
        "default_display_currency_code": "xyz789",
        "default_keywords": "abc123",
        "default_title": "abc123",
        "demonotice": 123,
        "display_product_prices_in_catalog": 123,
        "display_shipping_prices": 123,
        "display_state_if_optional": true,
        "enable_multiple_wishlists": "xyz789",
        "fixed_product_taxes_apply_tax_to_fpt": false,
        "fixed_product_taxes_display_prices_in_emails": 123,
        "fixed_product_taxes_display_prices_in_product_lists": 987,
        "fixed_product_taxes_display_prices_in_sales_modules": 987,
        "fixed_product_taxes_display_prices_on_product_view_page": 987,
        "fixed_product_taxes_enable": true,
        "fixed_product_taxes_include_fpt_in_subtotal": true,
        "front": "xyz789",
        "graphql_share_customer_group": true,
        "grid_per_page": 987,
        "grid_per_page_values": "abc123",
        "grouped_product_image": "ITSELF",
        "head_includes": "abc123",
        "head_shortcut_icon": "xyz789",
        "header_logo_src": "xyz789",
        "id": 987,
        "is_checkout_agreements_enabled": false,
        "is_default_store": true,
        "is_default_store_group": false,
        "is_guest_checkout_enabled": true,
        "is_negotiable_quote_active": true,
        "is_one_page_checkout_enabled": false,
        "is_requisition_list_active": "xyz789",
        "list_mode": "abc123",
        "list_per_page": 123,
        "list_per_page_values": "xyz789",
        "locale": "xyz789",
        "logo_alt": "xyz789",
        "logo_height": 123,
        "logo_width": 987,
        "magento_reward_general_is_enabled": "abc123",
        "magento_reward_general_is_enabled_on_front": "abc123",
        "magento_reward_general_min_points_balance": "xyz789",
        "magento_reward_general_publish_history": "xyz789",
        "magento_reward_points_invitation_customer": "xyz789",
        "magento_reward_points_invitation_customer_limit": "abc123",
        "magento_reward_points_invitation_order": "xyz789",
        "magento_reward_points_invitation_order_limit": "abc123",
        "magento_reward_points_newsletter": "xyz789",
        "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": true,
        "minicart_max_items": 123,
        "minimum_password_length": "abc123",
        "newsletter_enabled": false,
        "no_route": "xyz789",
        "optional_zip_countries": "xyz789",
        "order_cancellation_enabled": true,
        "order_cancellation_reasons": [
          CancellationReason
        ],
        "orders_invoices_credit_memos_display_full_summary": true,
        "orders_invoices_credit_memos_display_grandtotal": false,
        "orders_invoices_credit_memos_display_price": 987,
        "orders_invoices_credit_memos_display_shipping_amount": 987,
        "orders_invoices_credit_memos_display_subtotal": 123,
        "orders_invoices_credit_memos_display_zero_tax": true,
        "payment_payflowpro_cc_vault_active": "xyz789",
        "printed_card_price": "abc123",
        "printed_card_priceV2": Money,
        "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
        "product_reviews_enabled": "xyz789",
        "product_url_suffix": "abc123",
        "quickorder_active": false,
        "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": "abc123",
        "sales_printed_card": "abc123",
        "secure_base_link_url": "abc123",
        "secure_base_media_url": "abc123",
        "secure_base_static_url": "xyz789",
        "secure_base_url": "abc123",
        "send_friend": SendFriendConfiguration,
        "share_active_segments": true,
        "share_applied_cart_rule": true,
        "shopping_cart_display_full_summary": true,
        "shopping_cart_display_grand_total": false,
        "shopping_cart_display_price": 987,
        "shopping_cart_display_shipping": 123,
        "shopping_cart_display_subtotal": 123,
        "shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX",
        "shopping_cart_display_zero_tax": false,
        "show_cms_breadcrumbs": 123,
        "store_code": "4",
        "store_group_code": 4,
        "store_group_name": "xyz789",
        "store_name": "abc123",
        "store_sort_order": 987,
        "timezone": "xyz789",
        "title_prefix": "abc123",
        "title_separator": "xyz789",
        "title_suffix": "xyz789",
        "use_store_in_url": false,
        "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": "xyz789",
        "zero_subtotal_payment_from_specific_countries": "abc123",
        "zero_subtotal_sort_order": 123,
        "zero_subtotal_title": "abc123"
      }
    ]
  }
}

cart

Return information about the specified shopping cart.

Response: 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
    rules {
      ...CartRuleStorefrontFragment
    }
    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": "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": true,
      "rules": [CartRuleStorefront],
      "selected_payment_method": SelectedPaymentMethod,
      "shipping_addresses": [ShippingCartAddress],
      "total_quantity": 987.65
    }
  }
}

categories

Return a list of categories that match the specified filter.

Response: 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

Deprecated

Use categories instead.

Search for categories that match the criteria specified in the search and filter attributes.

Response: 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": ["abc123"],
      "breadcrumbs": [Breadcrumb],
      "canonical_url": "xyz789",
      "children": [CategoryTree],
      "children_count": "abc123",
      "cms_block": CmsBlock,
      "created_at": "xyz789",
      "custom_layout_update_file": "abc123",
      "default_sort_by": "abc123",
      "description": "xyz789",
      "display_mode": "xyz789",
      "filter_price_range": 123.45,
      "id": 123,
      "image": "xyz789",
      "include_in_menu": 123,
      "is_anchor": 123,
      "landing_page": 123,
      "level": 987,
      "meta_description": "xyz789",
      "meta_keywords": "xyz789",
      "meta_title": "abc123",
      "name": "xyz789",
      "path": "abc123",
      "path_in_store": "abc123",
      "position": 987,
      "product_count": 123,
      "products": CategoryProducts,
      "redirect_code": 987,
      "relative_url": "xyz789",
      "staged": true,
      "type": "CMS_PAGE",
      "uid": "4",
      "updated_at": "abc123",
      "url_key": "abc123",
      "url_path": "xyz789",
      "url_suffix": "abc123"
    }
  }
}

categoryList

Deprecated

Use categories instead.

Return an array of categories based on the specified filters.

Response: [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": "xyz789",
        "available_sort_by": ["abc123"],
        "breadcrumbs": [Breadcrumb],
        "canonical_url": "xyz789",
        "children": [CategoryTree],
        "children_count": "xyz789",
        "cms_block": CmsBlock,
        "created_at": "abc123",
        "custom_layout_update_file": "xyz789",
        "default_sort_by": "xyz789",
        "description": "xyz789",
        "display_mode": "abc123",
        "filter_price_range": 123.45,
        "id": 123,
        "image": "xyz789",
        "include_in_menu": 123,
        "is_anchor": 987,
        "landing_page": 123,
        "level": 123,
        "meta_description": "abc123",
        "meta_keywords": "abc123",
        "meta_title": "xyz789",
        "name": "abc123",
        "path": "abc123",
        "path_in_store": "xyz789",
        "position": 987,
        "product_count": 987,
        "products": CategoryProducts,
        "redirect_code": 123,
        "relative_url": "xyz789",
        "staged": false,
        "type": "CMS_PAGE",
        "uid": 4,
        "updated_at": "abc123",
        "url_key": "xyz789",
        "url_path": "abc123",
        "url_suffix": "abc123"
      }
    ]
  }
}

checkoutAgreements

Return Terms and Conditions configuration information.

Response: [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": "abc123",
        "content_height": "xyz789",
        "is_html": false,
        "mode": "AUTO",
        "name": "abc123"
      }
    ]
  }
}

cmsBlocks

Return information about CMS blocks.

Response: 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

Return details about a CMS page.

Response: CmsPage

Arguments

Name
Description
id - Int
The ID of the CMS page.
identifier - String
The identifier of the CMS page.

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": 123, "identifier": "abc123"}
Response
{
  "data": {
    "cmsPage": {
      "content": "xyz789",
      "content_heading": "xyz789",
      "identifier": "abc123",
      "meta_description": "xyz789",
      "meta_keywords": "abc123",
      "meta_title": "xyz789",
      "page_layout": "xyz789",
      "redirect_code": 123,
      "relative_url": "abc123",
      "title": "xyz789",
      "type": "CMS_PAGE",
      "url_key": "xyz789"
    }
  }
}

company

Return detailed information about the customer's company within the current company context.

Response: 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": "xyz789",
      "id": 4,
      "legal_address": CompanyLegalAddress,
      "legal_name": "abc123",
      "name": "abc123",
      "payment_methods": ["xyz789"],
      "reseller_id": "xyz789",
      "role": CompanyRole,
      "roles": CompanyRoles,
      "sales_representative": CompanySalesRepresentative,
      "structure": CompanyStructure,
      "team": CompanyTeam,
      "user": Customer,
      "users": CompanyUsers,
      "vat_tax_id": "xyz789"
    }
  }
}

compareList

Return products that have been added to the specified compare list.

Response: 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

The countries query provides information for all countries.

Response: [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": "xyz789",
        "full_name_locale": "xyz789",
        "id": "abc123",
        "three_letter_abbreviation": "abc123",
        "two_letter_abbreviation": "abc123"
      }
    ]
  }
}

country

The countries query provides information for a single country.

Response: Country

Arguments

Name
Description
id - String

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": "xyz789",
      "id": "abc123",
      "three_letter_abbreviation": "xyz789",
      "two_letter_abbreviation": "xyz789"
    }
  }
}

currency

Return information about the store's currency.

Response: 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": [
        "xyz789"
      ],
      "base_currency_code": "xyz789",
      "base_currency_symbol": "xyz789",
      "default_display_currecy_code": "xyz789",
      "default_display_currecy_symbol": "xyz789",
      "default_display_currency_code": "abc123",
      "default_display_currency_symbol": "abc123",
      "exchange_rates": [ExchangeRate]
    }
  }
}

customAttributeMetadata

Deprecated

Use customAttributeMetadataV2 query instead.

Return the attribute type, given an attribute code and entity type.

Response: 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

Retrieve EAV attributes metadata.

Response: 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

Return detailed information about a customer account.

Response: Customer

Example

Query
query customer {
  customer {
    addresses {
      ...CustomerAddressFragment
    }
    addressesV2 {
      ...CustomerAddressesFragment
    }
    allow_remote_shopping_assistance
    companies {
      ...UserCompaniesOutputFragment
    }
    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 {
      ...CustomerGroupStorefrontFragment
    }
    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
    }
    segments {
      ...CustomerSegmentStorefrontFragment
    }
    status
    store_credit {
      ...CustomerStoreCreditFragment
    }
    structure_id
    suffix
    taxvat
    team {
      ...CompanyTeamFragment
    }
    telephone
    wishlist {
      ...WishlistFragment
    }
    wishlist_v2 {
      ...WishlistFragment
    }
    wishlists {
      ...WishlistFragment
    }
  }
}
Response
{
  "data": {
    "customer": {
      "addresses": [CustomerAddress],
      "addressesV2": CustomerAddresses,
      "allow_remote_shopping_assistance": true,
      "companies": UserCompaniesOutput,
      "compare_list": CompareList,
      "confirmation_status": "ACCOUNT_CONFIRMED",
      "created_at": "xyz789",
      "custom_attributes": [AttributeValueInterface],
      "date_of_birth": "xyz789",
      "default_billing": "xyz789",
      "default_shipping": "abc123",
      "dob": "xyz789",
      "email": "xyz789",
      "firstname": "xyz789",
      "gender": 123,
      "gift_registries": [GiftRegistry],
      "gift_registry": GiftRegistry,
      "group": CustomerGroupStorefront,
      "group_id": 123,
      "id": 4,
      "is_subscribed": false,
      "job_title": "abc123",
      "lastname": "abc123",
      "middlename": "xyz789",
      "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,
      "segments": [CustomerSegmentStorefront],
      "status": "ACTIVE",
      "store_credit": CustomerStoreCredit,
      "structure_id": 4,
      "suffix": "abc123",
      "taxvat": "xyz789",
      "team": CompanyTeam,
      "telephone": "abc123",
      "wishlist": Wishlist,
      "wishlist_v2": Wishlist,
      "wishlists": [Wishlist]
    }
  }
}

customerCart

Return information about the customer's shopping cart.

Response: 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
    rules {
      ...CartRuleStorefrontFragment
    }
    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": true,
      "gift_wrapping": GiftWrapping,
      "id": "4",
      "is_virtual": true,
      "items": [CartItemInterface],
      "itemsV2": CartItems,
      "prices": CartPrices,
      "printed_card_included": false,
      "rules": [CartRuleStorefront],
      "selected_payment_method": SelectedPaymentMethod,
      "shipping_addresses": [ShippingCartAddress],
      "total_quantity": 987.65
    }
  }
}

customerDownloadableProducts

Return a list of downloadable products the customer has purchased.

Response: CustomerDownloadableProducts

Example

Query
query customerDownloadableProducts {
  customerDownloadableProducts {
    items {
      ...CustomerDownloadableProductFragment
    }
  }
}
Response
{
  "data": {
    "customerDownloadableProducts": {
      "items": [CustomerDownloadableProduct]
    }
  }
}

customerGroup

Provides Customer Group assigned to the Customer or Guest.

Response: CustomerGroupStorefront!

Example

Query
query customerGroup {
  customerGroup {
    uid
  }
}
Response
{"data": {"customerGroup": {"uid": "4"}}}

customerOrders

Deprecated

Use the customer query instead.

Response: CustomerOrders

Example

Query
query customerOrders {
  customerOrders {
    date_of_first_order
    items {
      ...CustomerOrderFragment
    }
    page_info {
      ...SearchResultPageInfoFragment
    }
    total_count
  }
}
Response
{
  "data": {
    "customerOrders": {
      "date_of_first_order": "xyz789",
      "items": [CustomerOrder],
      "page_info": SearchResultPageInfo,
      "total_count": 123
    }
  }
}

customerPaymentTokens

Return a list of customer payment tokens stored in the vault.

Response: CustomerPaymentTokens

Example

Query
query customerPaymentTokens {
  customerPaymentTokens {
    items {
      ...PaymentTokenFragment
    }
  }
}
Response
{
  "data": {
    "customerPaymentTokens": {"items": [PaymentToken]}
  }
}

customerSegments

Customer segments associated with the current customer or guest/visitor.

Response: [CustomerSegmentStorefront]

Arguments

Name
Description
cartId - String!
The unique ID of the cart to query.

Example

Query
query customerSegments($cartId: String!) {
  customerSegments(cartId: $cartId) {
    uid
  }
}
Variables
{"cartId": "xyz789"}
Response
{
  "data": {
    "customerSegments": [{"uid": "4"}]
  }
}

dynamicBlocks

Return a list of dynamic blocks filtered by type, location, or UIDs.

Response: 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

Retrieve the secure PayPal URL for a Payments Pro Hosted Solution transaction.

Response: 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

Retrieve payment credentials for a transaction. Use this query for Payflow Link and Payments Advanced payment methods.

Response: 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": "abc123",
      "secure_token_id": "xyz789"
    }
  }
}

getPaymentConfig

Retrieves the payment configuration for a given location

Response: 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
    }
    fastlane {
      ...FastlaneConfigFragment
    }
    google_pay {
      ...GooglePayConfigFragment
    }
    hosted_fields {
      ...HostedFieldsConfigFragment
    }
    smart_buttons {
      ...SmartButtonsConfigFragment
    }
  }
}
Variables
{"location": "PRODUCT_DETAIL"}
Response
{
  "data": {
    "getPaymentConfig": {
      "apple_pay": ApplePayConfig,
      "fastlane": FastlaneConfig,
      "google_pay": GooglePayConfig,
      "hosted_fields": HostedFieldsConfig,
      "smart_buttons": SmartButtonsConfig
    }
  }
}

getPaymentOrder

Retrieves the payment details for the order

Response: PaymentOrderOutput

Arguments

Name
Description
cartId - String!
The customer cart ID
id - String!
PayPal order ID

Example

Query
query getPaymentOrder(
  $cartId: String!,
  $id: String!
) {
  getPaymentOrder(
    cartId: $cartId,
    id: $id
  ) {
    id
    mp_order_id
    payment_source_details {
      ...PaymentSourceDetailsFragment
    }
    status
  }
}
Variables
{
  "cartId": "abc123",
  "id": "abc123"
}
Response
{
  "data": {
    "getPaymentOrder": {
      "id": "xyz789",
      "mp_order_id": "abc123",
      "payment_source_details": PaymentSourceDetails,
      "status": "xyz789"
    }
  }
}

getPaymentSDK

Gets the payment SDK urls and values

Response: 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]}
  }
}

getVaultConfig

Retrieves the vault configuration

Response: VaultConfigOutput

Example

Query
query getVaultConfig {
  getVaultConfig {
    credit_card {
      ...VaultCreditCardConfigFragment
    }
  }
}
Response
{
  "data": {
    "getVaultConfig": {
      "credit_card": VaultCreditCardConfig
    }
  }
}

giftCardAccount

Return details about a specific gift card.

Response: 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

Return the specified gift registry. Some details will not be available to guests.

Response: 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": "abc123",
      "dynamic_attributes": [
        GiftRegistryDynamicAttribute
      ],
      "event_name": "abc123",
      "items": [GiftRegistryItemInterface],
      "message": "abc123",
      "owner_name": "abc123",
      "privacy_settings": "PRIVATE",
      "registrants": [GiftRegistryRegistrant],
      "shipping_address": CustomerAddress,
      "status": "ACTIVE",
      "type": GiftRegistryType,
      "uid": 4
    }
  }
}

giftRegistryEmailSearch

Search for gift registries by specifying a registrant email address.

Response: [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": "abc123",
        "name": "xyz789",
        "type": "xyz789"
      }
    ]
  }
}

giftRegistryIdSearch

Search for gift registries by specifying a registry URL key.

Response: [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": "abc123",
        "gift_registry_uid": "4",
        "location": "abc123",
        "name": "abc123",
        "type": "abc123"
      }
    ]
  }
}

giftRegistryTypeSearch

Search for gift registries by specifying the registrant name and registry type ID.

Response: [GiftRegistrySearchResult]

Arguments

Name
Description
firstName - String!
The first name of the registrant.
lastName - String!
The last name of the registrant.
giftRegistryTypeUid - ID
The type UID of the registry.

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": "xyz789",
        "name": "abc123",
        "type": "xyz789"
      }
    ]
  }
}

giftRegistryTypes

Get a list of available gift registry types.

Response: [GiftRegistryType]

Example

Query
query giftRegistryTypes {
  giftRegistryTypes {
    dynamic_attributes_metadata {
      ...GiftRegistryDynamicAttributeMetadataInterfaceFragment
    }
    label
    uid
  }
}
Response
{
  "data": {
    "giftRegistryTypes": [
      {
        "dynamic_attributes_metadata": [
          GiftRegistryDynamicAttributeMetadataInterface
        ],
        "label": "xyz789",
        "uid": "4"
      }
    ]
  }
}

guestOrder

Retrieve guest order details based on number, email and billing last name.

Response: CustomerOrder!

Arguments

Name
Description
input - GuestOrderInformationInput!

Example

Query
query guestOrder($input: GuestOrderInformationInput!) {
  guestOrder(input: $input) {
    applied_coupons {
      ...AppliedCouponFragment
    }
    applied_gift_cards {
      ...ApplyGiftCardToOrderFragment
    }
    available_actions
    billing_address {
      ...OrderAddressFragment
    }
    carrier
    comments {
      ...SalesCommentItemFragment
    }
    created_at
    credit_memos {
      ...CreditMemoFragment
    }
    customer_info {
      ...OrderCustomerInfoFragment
    }
    email
    gift_message {
      ...GiftMessageFragment
    }
    gift_receipt_included
    gift_wrapping {
      ...GiftWrappingFragment
    }
    grand_total
    id
    increment_id
    invoices {
      ...InvoiceFragment
    }
    is_virtual
    items {
      ...OrderItemInterfaceFragment
    }
    items_eligible_for_return {
      ...OrderItemInterfaceFragment
    }
    number
    order_date
    order_number
    order_status_change_date
    payment_methods {
      ...OrderPaymentMethodFragment
    }
    printed_card_included
    returns {
      ...ReturnsFragment
    }
    shipments {
      ...OrderShipmentFragment
    }
    shipping_address {
      ...OrderAddressFragment
    }
    shipping_method
    status
    token
    total {
      ...OrderTotalFragment
    }
  }
}
Variables
{"input": GuestOrderInformationInput}
Response
{
  "data": {
    "guestOrder": {
      "applied_coupons": [AppliedCoupon],
      "applied_gift_cards": [ApplyGiftCardToOrder],
      "available_actions": ["REORDER"],
      "billing_address": OrderAddress,
      "carrier": "xyz789",
      "comments": [SalesCommentItem],
      "created_at": "abc123",
      "credit_memos": [CreditMemo],
      "customer_info": OrderCustomerInfo,
      "email": "xyz789",
      "gift_message": GiftMessage,
      "gift_receipt_included": true,
      "gift_wrapping": GiftWrapping,
      "grand_total": 123.45,
      "id": "4",
      "increment_id": "abc123",
      "invoices": [Invoice],
      "is_virtual": true,
      "items": [OrderItemInterface],
      "items_eligible_for_return": [OrderItemInterface],
      "number": "xyz789",
      "order_date": "xyz789",
      "order_number": "xyz789",
      "order_status_change_date": "abc123",
      "payment_methods": [OrderPaymentMethod],
      "printed_card_included": true,
      "returns": Returns,
      "shipments": [OrderShipment],
      "shipping_address": OrderAddress,
      "shipping_method": "abc123",
      "status": "xyz789",
      "token": "xyz789",
      "total": OrderTotal
    }
  }
}

guestOrderByToken

Retrieve guest order details based on token.

Response: CustomerOrder!

Arguments

Name
Description
input - OrderTokenInput!

Example

Query
query guestOrderByToken($input: OrderTokenInput!) {
  guestOrderByToken(input: $input) {
    applied_coupons {
      ...AppliedCouponFragment
    }
    applied_gift_cards {
      ...ApplyGiftCardToOrderFragment
    }
    available_actions
    billing_address {
      ...OrderAddressFragment
    }
    carrier
    comments {
      ...SalesCommentItemFragment
    }
    created_at
    credit_memos {
      ...CreditMemoFragment
    }
    customer_info {
      ...OrderCustomerInfoFragment
    }
    email
    gift_message {
      ...GiftMessageFragment
    }
    gift_receipt_included
    gift_wrapping {
      ...GiftWrappingFragment
    }
    grand_total
    id
    increment_id
    invoices {
      ...InvoiceFragment
    }
    is_virtual
    items {
      ...OrderItemInterfaceFragment
    }
    items_eligible_for_return {
      ...OrderItemInterfaceFragment
    }
    number
    order_date
    order_number
    order_status_change_date
    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],
      "applied_gift_cards": [ApplyGiftCardToOrder],
      "available_actions": ["REORDER"],
      "billing_address": OrderAddress,
      "carrier": "xyz789",
      "comments": [SalesCommentItem],
      "created_at": "abc123",
      "credit_memos": [CreditMemo],
      "customer_info": OrderCustomerInfo,
      "email": "xyz789",
      "gift_message": GiftMessage,
      "gift_receipt_included": true,
      "gift_wrapping": GiftWrapping,
      "grand_total": 987.65,
      "id": 4,
      "increment_id": "abc123",
      "invoices": [Invoice],
      "is_virtual": true,
      "items": [OrderItemInterface],
      "items_eligible_for_return": [OrderItemInterface],
      "number": "abc123",
      "order_date": "xyz789",
      "order_number": "xyz789",
      "order_status_change_date": "xyz789",
      "payment_methods": [OrderPaymentMethod],
      "printed_card_included": true,
      "returns": Returns,
      "shipments": [OrderShipment],
      "shipping_address": OrderAddress,
      "shipping_method": "xyz789",
      "status": "xyz789",
      "token": "abc123",
      "total": OrderTotal
    }
  }
}

isCompanyAdminEmailAvailable

Check whether the specified email can be used to register a company admin.

Response: IsCompanyAdminEmailAvailableOutput

Arguments

Name
Description
email - String!

Example

Query
query isCompanyAdminEmailAvailable($email: String!) {
  isCompanyAdminEmailAvailable(email: $email) {
    is_email_available
  }
}
Variables
{"email": "xyz789"}
Response
{"data": {"isCompanyAdminEmailAvailable": {"is_email_available": true}}}

isCompanyEmailAvailable

Check whether the specified email can be used to register a new company.

Response: 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

Check whether the specified role name is valid for the company.

Response: 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": false}}}

isCompanyUserEmailAvailable

Check whether the specified email can be used to register a company user.

Response: IsCompanyUserEmailAvailableOutput

Arguments

Name
Description
email - String!

Example

Query
query isCompanyUserEmailAvailable($email: String!) {
  isCompanyUserEmailAvailable(email: $email) {
    is_email_available
  }
}
Variables
{"email": "xyz789"}
Response
{"data": {"isCompanyUserEmailAvailable": {"is_email_available": false}}}

isEmailAvailable

Check whether the specified email has already been used to create a customer account.

Response: 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": "abc123"}
Response
{"data": {"isEmailAvailable": {"is_email_available": true}}}

negotiableQuote

Retrieve the specified negotiable quote.

Response: 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": "xyz789",
      "email": "xyz789",
      "history": [NegotiableQuoteHistoryEntry],
      "is_virtual": false,
      "items": [CartItemInterface],
      "name": "abc123",
      "prices": CartPrices,
      "selected_payment_method": SelectedPaymentMethod,
      "shipping_addresses": [
        NegotiableQuoteShippingAddress
      ],
      "status": "SUBMITTED",
      "total_quantity": 987.65,
      "uid": 4,
      "updated_at": "xyz789"
    }
  }
}

negotiableQuoteTemplate

Retrieve the specified negotiable quote template.

Response: NegotiableQuoteTemplate

Arguments

Name
Description
templateId - ID!

Example

Query
query negotiableQuoteTemplate($templateId: ID!) {
  negotiableQuoteTemplate(templateId: $templateId) {
    buyer {
      ...NegotiableQuoteUserFragment
    }
    comments {
      ...NegotiableQuoteCommentFragment
    }
    expiration_date
    history {
      ...NegotiableQuoteHistoryEntryFragment
    }
    is_min_max_qty_used
    is_virtual
    items {
      ...CartItemInterfaceFragment
    }
    max_order_commitment
    min_order_commitment
    name
    notifications {
      ...QuoteTemplateNotificationMessageFragment
    }
    prices {
      ...CartPricesFragment
    }
    reference_document_links {
      ...NegotiableQuoteReferenceDocumentLinkFragment
    }
    shipping_addresses {
      ...NegotiableQuoteShippingAddressFragment
    }
    status
    template_id
    total_quantity
  }
}
Variables
{"templateId": "4"}
Response
{
  "data": {
    "negotiableQuoteTemplate": {
      "buyer": NegotiableQuoteUser,
      "comments": [NegotiableQuoteComment],
      "expiration_date": "xyz789",
      "history": [NegotiableQuoteHistoryEntry],
      "is_min_max_qty_used": true,
      "is_virtual": true,
      "items": [CartItemInterface],
      "max_order_commitment": 123,
      "min_order_commitment": 987,
      "name": "xyz789",
      "notifications": [QuoteTemplateNotificationMessage],
      "prices": CartPrices,
      "reference_document_links": [
        NegotiableQuoteReferenceDocumentLink
      ],
      "shipping_addresses": [
        NegotiableQuoteShippingAddress
      ],
      "status": "xyz789",
      "template_id": 4,
      "total_quantity": 987.65
    }
  }
}

negotiableQuoteTemplates

Return a list of negotiable quote templates that can be viewed by the logged-in customer.

Response: NegotiableQuoteTemplatesOutput

Arguments

Name
Description
filter - NegotiableQuoteTemplateFilterInput
The filter to use to determine which negotiable quote templates 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 - NegotiableQuoteTemplateSortInput
The field to use for sorting results.

Example

Query
query negotiableQuoteTemplates(
  $filter: NegotiableQuoteTemplateFilterInput,
  $pageSize: Int,
  $currentPage: Int,
  $sort: NegotiableQuoteTemplateSortInput
) {
  negotiableQuoteTemplates(
    filter: $filter,
    pageSize: $pageSize,
    currentPage: $currentPage,
    sort: $sort
  ) {
    items {
      ...NegotiableQuoteTemplateGridItemFragment
    }
    page_info {
      ...SearchResultPageInfoFragment
    }
    sort_fields {
      ...SortFieldsFragment
    }
    total_count
  }
}
Variables
{
  "filter": NegotiableQuoteTemplateFilterInput,
  "pageSize": 20,
  "currentPage": 1,
  "sort": NegotiableQuoteTemplateSortInput
}
Response
{
  "data": {
    "negotiableQuoteTemplates": {
      "items": [NegotiableQuoteTemplateGridItem],
      "page_info": SearchResultPageInfo,
      "sort_fields": SortFields,
      "total_count": 123
    }
  }
}

negotiableQuotes

Return a list of negotiable quotes that can be viewed by the logged-in customer.

Response: 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": 123
    }
  }
}

pickupLocations

The pickup locations query searches for locations that match the search request requirements.

Response: 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

Return the active ratings attributes and the values each rating can have.

Response: ProductReviewRatingsMetadata!

Example

Query
query productReviewRatingsMetadata {
  productReviewRatingsMetadata {
    items {
      ...ProductReviewRatingMetadataFragment
    }
  }
}
Response
{
  "data": {
    "productReviewRatingsMetadata": {
      "items": [ProductReviewRatingMetadata]
    }
  }
}

products

Search for products that match the criteria specified in the search and filter attributes.

Response: 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": "abc123",
  "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": 123
    }
  }
}

recaptchaFormConfig

Response: ReCaptchaConfigOutput

Arguments

Name
Description
formType - ReCaptchaFormEnum!

Example

Query
query recaptchaFormConfig($formType: ReCaptchaFormEnum!) {
  recaptchaFormConfig(formType: $formType) {
    configurations {
      ...ReCaptchaConfigurationFragment
    }
    is_enabled
  }
}
Variables
{"formType": "PLACE_ORDER"}
Response
{
  "data": {
    "recaptchaFormConfig": {
      "configurations": ReCaptchaConfiguration,
      "is_enabled": false
    }
  }
}

recaptchaV3Config

Returns details about Google reCAPTCHA V3-Invisible configuration.

Response: ReCaptchaConfigurationV3

Example

Query
query recaptchaV3Config {
  recaptchaV3Config {
    badge_position
    failure_message
    forms
    is_enabled
    language_code
    minimum_score
    theme
    website_key
  }
}
Response
{
  "data": {
    "recaptchaV3Config": {
      "badge_position": "xyz789",
      "failure_message": "xyz789",
      "forms": ["PLACE_ORDER"],
      "is_enabled": false,
      "language_code": "abc123",
      "minimum_score": 987.65,
      "theme": "xyz789",
      "website_key": "abc123"
    }
  }
}

route

Return the full details for a specified product, category, or CMS page.

Response: 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": "abc123"}
Response
{
  "data": {
    "route": {
      "redirect_code": 123,
      "relative_url": "abc123",
      "type": "CMS_PAGE"
    }
  }
}

storeConfig

Return details about the store's configuration.

Response: 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_merge_preference
    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_product_image
    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_product_prices_in_catalog
    display_shipping_prices
    display_state_if_optional
    enable_multiple_wishlists
    fixed_product_taxes_apply_tax_to_fpt
    fixed_product_taxes_display_prices_in_emails
    fixed_product_taxes_display_prices_in_product_lists
    fixed_product_taxes_display_prices_in_sales_modules
    fixed_product_taxes_display_prices_on_product_view_page
    fixed_product_taxes_enable
    fixed_product_taxes_include_fpt_in_subtotal
    front
    graphql_share_customer_group
    grid_per_page
    grid_per_page_values
    grouped_product_image
    head_includes
    head_shortcut_icon
    header_logo_src
    id
    is_checkout_agreements_enabled
    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
    }
    orders_invoices_credit_memos_display_full_summary
    orders_invoices_credit_memos_display_grandtotal
    orders_invoices_credit_memos_display_price
    orders_invoices_credit_memos_display_shipping_amount
    orders_invoices_credit_memos_display_subtotal
    orders_invoices_credit_memos_display_zero_tax
    payment_payflowpro_cc_vault_active
    printed_card_price
    printed_card_priceV2 {
      ...MoneyFragment
    }
    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
    }
    share_active_segments
    share_applied_cart_rule
    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": "xyz789",
      "allow_items": "xyz789",
      "allow_order": "xyz789",
      "allow_printed_card": "abc123",
      "autocomplete_on_storefront": false,
      "base_currency_code": "abc123",
      "base_link_url": "xyz789",
      "base_media_url": "abc123",
      "base_static_url": "xyz789",
      "base_url": "abc123",
      "braintree_3dsecure_allowspecific": true,
      "braintree_3dsecure_always_request_3ds": false,
      "braintree_3dsecure_specificcountry": "abc123",
      "braintree_3dsecure_threshold_amount": "xyz789",
      "braintree_3dsecure_verify_3dsecure": true,
      "braintree_ach_direct_debit_vault_active": true,
      "braintree_applepay_merchant_name": "abc123",
      "braintree_applepay_vault_active": false,
      "braintree_cc_vault_active": "xyz789",
      "braintree_cc_vault_cvv": false,
      "braintree_environment": "xyz789",
      "braintree_googlepay_btn_color": "xyz789",
      "braintree_googlepay_cctypes": "abc123",
      "braintree_googlepay_merchant_id": "abc123",
      "braintree_googlepay_vault_active": true,
      "braintree_local_payment_allowed_methods": "xyz789",
      "braintree_local_payment_fallback_button_text": "abc123",
      "braintree_local_payment_redirect_on_fail": "xyz789",
      "braintree_merchant_account_id": "xyz789",
      "braintree_paypal_button_location_cart_type_credit_color": "abc123",
      "braintree_paypal_button_location_cart_type_credit_label": "abc123",
      "braintree_paypal_button_location_cart_type_credit_shape": "xyz789",
      "braintree_paypal_button_location_cart_type_credit_show": true,
      "braintree_paypal_button_location_cart_type_messaging_layout": "xyz789",
      "braintree_paypal_button_location_cart_type_messaging_logo": "xyz789",
      "braintree_paypal_button_location_cart_type_messaging_logo_position": "abc123",
      "braintree_paypal_button_location_cart_type_messaging_show": false,
      "braintree_paypal_button_location_cart_type_messaging_text_color": "abc123",
      "braintree_paypal_button_location_cart_type_paylater_color": "xyz789",
      "braintree_paypal_button_location_cart_type_paylater_label": "xyz789",
      "braintree_paypal_button_location_cart_type_paylater_shape": "abc123",
      "braintree_paypal_button_location_cart_type_paylater_show": false,
      "braintree_paypal_button_location_cart_type_paypal_color": "xyz789",
      "braintree_paypal_button_location_cart_type_paypal_label": "xyz789",
      "braintree_paypal_button_location_cart_type_paypal_shape": "xyz789",
      "braintree_paypal_button_location_cart_type_paypal_show": true,
      "braintree_paypal_button_location_checkout_type_credit_color": "abc123",
      "braintree_paypal_button_location_checkout_type_credit_label": "abc123",
      "braintree_paypal_button_location_checkout_type_credit_shape": "xyz789",
      "braintree_paypal_button_location_checkout_type_credit_show": false,
      "braintree_paypal_button_location_checkout_type_messaging_layout": "abc123",
      "braintree_paypal_button_location_checkout_type_messaging_logo": "xyz789",
      "braintree_paypal_button_location_checkout_type_messaging_logo_position": "abc123",
      "braintree_paypal_button_location_checkout_type_messaging_show": true,
      "braintree_paypal_button_location_checkout_type_messaging_text_color": "xyz789",
      "braintree_paypal_button_location_checkout_type_paylater_color": "abc123",
      "braintree_paypal_button_location_checkout_type_paylater_label": "xyz789",
      "braintree_paypal_button_location_checkout_type_paylater_shape": "xyz789",
      "braintree_paypal_button_location_checkout_type_paylater_show": true,
      "braintree_paypal_button_location_checkout_type_paypal_color": "xyz789",
      "braintree_paypal_button_location_checkout_type_paypal_label": "xyz789",
      "braintree_paypal_button_location_checkout_type_paypal_shape": "xyz789",
      "braintree_paypal_button_location_checkout_type_paypal_show": true,
      "braintree_paypal_button_location_productpage_type_credit_color": "xyz789",
      "braintree_paypal_button_location_productpage_type_credit_label": "abc123",
      "braintree_paypal_button_location_productpage_type_credit_shape": "abc123",
      "braintree_paypal_button_location_productpage_type_credit_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": "xyz789",
      "braintree_paypal_button_location_productpage_type_messaging_show": false,
      "braintree_paypal_button_location_productpage_type_messaging_text_color": "abc123",
      "braintree_paypal_button_location_productpage_type_paylater_color": "xyz789",
      "braintree_paypal_button_location_productpage_type_paylater_label": "xyz789",
      "braintree_paypal_button_location_productpage_type_paylater_shape": "abc123",
      "braintree_paypal_button_location_productpage_type_paylater_show": true,
      "braintree_paypal_button_location_productpage_type_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": false,
      "braintree_paypal_credit_uk_merchant_name": "abc123",
      "braintree_paypal_display_on_shopping_cart": false,
      "braintree_paypal_merchant_country": "xyz789",
      "braintree_paypal_merchant_name_override": "abc123",
      "braintree_paypal_require_billing_address": false,
      "braintree_paypal_send_cart_line_items": true,
      "braintree_paypal_vault_active": false,
      "cart_expires_in_days": 987,
      "cart_gift_wrapping": "xyz789",
      "cart_merge_preference": "abc123",
      "cart_printed_card": "xyz789",
      "cart_summary_display_quantity": 123,
      "catalog_default_sort_by": "abc123",
      "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
      "category_url_suffix": "xyz789",
      "check_money_order_enable_for_specific_countries": false,
      "check_money_order_enabled": false,
      "check_money_order_make_check_payable_to": "abc123",
      "check_money_order_max_order_total": "xyz789",
      "check_money_order_min_order_total": "xyz789",
      "check_money_order_new_order_status": "abc123",
      "check_money_order_payment_from_specific_countries": "abc123",
      "check_money_order_send_check_to": "abc123",
      "check_money_order_sort_order": 987,
      "check_money_order_title": "xyz789",
      "cms_home_page": "abc123",
      "cms_no_cookies": "abc123",
      "cms_no_route": "xyz789",
      "code": "xyz789",
      "configurable_product_image": "ITSELF",
      "configurable_thumbnail_source": "abc123",
      "contact_enabled": false,
      "copyright": "xyz789",
      "countries_with_required_region": "xyz789",
      "create_account_confirmation": false,
      "customer_access_token_lifetime": 123.45,
      "default_country": "abc123",
      "default_description": "xyz789",
      "default_display_currency_code": "abc123",
      "default_keywords": "xyz789",
      "default_title": "xyz789",
      "demonotice": 987,
      "display_product_prices_in_catalog": 123,
      "display_shipping_prices": 123,
      "display_state_if_optional": true,
      "enable_multiple_wishlists": "abc123",
      "fixed_product_taxes_apply_tax_to_fpt": true,
      "fixed_product_taxes_display_prices_in_emails": 123,
      "fixed_product_taxes_display_prices_in_product_lists": 987,
      "fixed_product_taxes_display_prices_in_sales_modules": 987,
      "fixed_product_taxes_display_prices_on_product_view_page": 987,
      "fixed_product_taxes_enable": false,
      "fixed_product_taxes_include_fpt_in_subtotal": false,
      "front": "xyz789",
      "graphql_share_customer_group": false,
      "grid_per_page": 123,
      "grid_per_page_values": "abc123",
      "grouped_product_image": "ITSELF",
      "head_includes": "xyz789",
      "head_shortcut_icon": "xyz789",
      "header_logo_src": "xyz789",
      "id": 987,
      "is_checkout_agreements_enabled": true,
      "is_default_store": false,
      "is_default_store_group": false,
      "is_guest_checkout_enabled": false,
      "is_negotiable_quote_active": false,
      "is_one_page_checkout_enabled": true,
      "is_requisition_list_active": "abc123",
      "list_mode": "xyz789",
      "list_per_page": 987,
      "list_per_page_values": "abc123",
      "locale": "abc123",
      "logo_alt": "abc123",
      "logo_height": 987,
      "logo_width": 123,
      "magento_reward_general_is_enabled": "abc123",
      "magento_reward_general_is_enabled_on_front": "abc123",
      "magento_reward_general_min_points_balance": "xyz789",
      "magento_reward_general_publish_history": "abc123",
      "magento_reward_points_invitation_customer": "abc123",
      "magento_reward_points_invitation_customer_limit": "abc123",
      "magento_reward_points_invitation_order": "xyz789",
      "magento_reward_points_invitation_order_limit": "xyz789",
      "magento_reward_points_newsletter": "abc123",
      "magento_reward_points_order": "xyz789",
      "magento_reward_points_register": "abc123",
      "magento_reward_points_review": "abc123",
      "magento_reward_points_review_limit": "abc123",
      "magento_wishlist_general_is_enabled": "abc123",
      "max_items_in_order_summary": 123,
      "maximum_number_of_wishlists": "xyz789",
      "minicart_display": false,
      "minicart_max_items": 123,
      "minimum_password_length": "abc123",
      "newsletter_enabled": true,
      "no_route": "abc123",
      "optional_zip_countries": "xyz789",
      "order_cancellation_enabled": false,
      "order_cancellation_reasons": [CancellationReason],
      "orders_invoices_credit_memos_display_full_summary": true,
      "orders_invoices_credit_memos_display_grandtotal": true,
      "orders_invoices_credit_memos_display_price": 987,
      "orders_invoices_credit_memos_display_shipping_amount": 987,
      "orders_invoices_credit_memos_display_subtotal": 123,
      "orders_invoices_credit_memos_display_zero_tax": true,
      "payment_payflowpro_cc_vault_active": "abc123",
      "printed_card_price": "abc123",
      "printed_card_priceV2": Money,
      "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
      "product_reviews_enabled": "xyz789",
      "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": "xyz789",
      "sales_printed_card": "abc123",
      "secure_base_link_url": "xyz789",
      "secure_base_media_url": "abc123",
      "secure_base_static_url": "abc123",
      "secure_base_url": "xyz789",
      "send_friend": SendFriendConfiguration,
      "share_active_segments": false,
      "share_applied_cart_rule": true,
      "shopping_cart_display_full_summary": false,
      "shopping_cart_display_grand_total": false,
      "shopping_cart_display_price": 123,
      "shopping_cart_display_shipping": 987,
      "shopping_cart_display_subtotal": 123,
      "shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX",
      "shopping_cart_display_zero_tax": true,
      "show_cms_breadcrumbs": 123,
      "store_code": "4",
      "store_group_code": 4,
      "store_group_name": "abc123",
      "store_name": "xyz789",
      "store_sort_order": 123,
      "timezone": "xyz789",
      "title_prefix": "xyz789",
      "title_separator": "xyz789",
      "title_suffix": "xyz789",
      "use_store_in_url": false,
      "website_code": 4,
      "website_id": 123,
      "website_name": "xyz789",
      "weight_unit": "abc123",
      "welcome": "abc123",
      "zero_subtotal_enable_for_specific_countries": false,
      "zero_subtotal_enabled": true,
      "zero_subtotal_new_order_status": "xyz789",
      "zero_subtotal_payment_action": "xyz789",
      "zero_subtotal_payment_from_specific_countries": "abc123",
      "zero_subtotal_sort_order": 987,
      "zero_subtotal_title": "abc123"
    }
  }
}

urlResolver

Deprecated

Use the route query instead.

Return the relative URL for a specified product, category or CMS page.

Response: 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": "xyz789"}
Response
{
  "data": {
    "urlResolver": {
      "canonical_url": "abc123",
      "entity_uid": "4",
      "id": 123,
      "redirectCode": 987,
      "relative_url": "xyz789",
      "type": "CMS_PAGE"
    }
  }
}

wishlist

Deprecated

Moved under Customer.wishlist.

Return the contents of a customer's wish list.

Response: WishlistOutput

Example

Query
query wishlist {
  wishlist {
    items {
      ...WishlistItemFragment
    }
    items_count
    name
    sharing_code
    updated_at
  }
}
Response
{
  "data": {
    "wishlist": {
      "items": [WishlistItem],
      "items_count": 123,
      "name": "abc123",
      "sharing_code": "abc123",
      "updated_at": "xyz789"
    }
  }
}