The Adobe Commerce as a Cloud Service GraphQL API allows you to quickly and efficiently transfer information between your Commerce store and your storefront. The schema documented here is autogenerated from a production instance of Adobe Commerce as a Cloud Service. This schema removes all deprecated queries, mutations, and fields from the core schema. It also replaces the core products and categories queries with identically-named queries defined in Catalog Service. If you are migrating to Adobe Commerce as a Cloud Service, you must update your applications to use these queries. For more information, refer to the GraphQL documentation.

API endpoint

https://<location>.api.commerce.adobe.com/<tenant-id>/graphql

Headers

For header information, refer to GraphQL headers.

Version

SaaS

Queries

attributeMetadata

Return a list of product attribute codes that can be used for sorting or filtering in a productSearch query

Response: AttributeMetadataResponse!

Example

Query
query attributeMetadata {
  attributeMetadata {
    filterableInSearch {
      ...FilterableInSearchAttributeFragment
    }
    sortable {
      ...SortableAttributeFragment
    }
  }
}
Response
{
  "data": {
    "attributeMetadata": {
      "filterableInSearch": [FilterableInSearchAttribute],
      "sortable": [SortableAttribute]
    }
  }
}

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": "abc123"}
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) {
    allow_company_registration
    allow_gift_receipt
    allow_gift_wrapping_on_order
    allow_gift_wrapping_on_order_items
    allow_items
    allow_order
    allow_printed_card
    autocomplete_on_storefront
    base_currency_code
    base_link_url
    base_media_url
    base_static_url
    base_url
    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
    company_credit_enabled
    company_enabled
    configurable_product_image
    configurable_thumbnail_source
    contact_enabled
    countries_with_required_region
    create_account_confirmation
    customer_access_token_lifetime
    default_country
    default_display_currency_code
    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
    graphql_share_customer_group
    grid_per_page
    grid_per_page_values
    grouped_product_image
    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
    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
    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
    persistent_enabled
    persistent_options_wishlist
    persistent_shopping_cart
    printed_card_priceV2 {
      ...MoneyFragment
    }
    product_alert_allow_stock
    product_fixed_product_tax_display_setting
    product_url_suffix
    quickorder_active
    quote_minimum_amount
    quote_minimum_amount_message
    required_character_classes_number
    requisition_list_share_link_validity_days
    requisition_list_share_max_recipients
    requisition_list_share_storefront_path
    requisition_list_sharing_enabled
    returns_enabled
    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
    share_active_segments
    share_applied_cart_rule
    share_customer_accounts_scope
    shopping_assistance_checkbox_title
    shopping_assistance_checkbox_tooltip
    shopping_assistance_enabled
    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
    store_code
    store_group_code
    store_group_name
    store_name
    store_sort_order
    timezone
    title_separator
    use_store_in_url
    website_code
    website_name
    weight_unit
    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": [
      {
        "allow_company_registration": true,
        "allow_gift_receipt": "abc123",
        "allow_gift_wrapping_on_order": "abc123",
        "allow_gift_wrapping_on_order_items": "abc123",
        "allow_items": "xyz789",
        "allow_order": "xyz789",
        "allow_printed_card": "abc123",
        "autocomplete_on_storefront": true,
        "base_currency_code": "abc123",
        "base_link_url": "abc123",
        "base_media_url": "xyz789",
        "base_static_url": "xyz789",
        "base_url": "abc123",
        "cart_expires_in_days": 123,
        "cart_gift_wrapping": "xyz789",
        "cart_merge_preference": "xyz789",
        "cart_printed_card": "abc123",
        "cart_summary_display_quantity": 123,
        "catalog_default_sort_by": "xyz789",
        "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
        "category_url_suffix": "xyz789",
        "check_money_order_enable_for_specific_countries": false,
        "check_money_order_enabled": true,
        "check_money_order_make_check_payable_to": "abc123",
        "check_money_order_max_order_total": "xyz789",
        "check_money_order_min_order_total": "abc123",
        "check_money_order_new_order_status": "xyz789",
        "check_money_order_payment_from_specific_countries": "abc123",
        "check_money_order_send_check_to": "xyz789",
        "check_money_order_sort_order": 987,
        "check_money_order_title": "abc123",
        "company_credit_enabled": true,
        "company_enabled": false,
        "configurable_product_image": "ITSELF",
        "configurable_thumbnail_source": "xyz789",
        "contact_enabled": true,
        "countries_with_required_region": "abc123",
        "create_account_confirmation": true,
        "customer_access_token_lifetime": 987.65,
        "default_country": "abc123",
        "default_display_currency_code": "abc123",
        "display_product_prices_in_catalog": 987,
        "display_shipping_prices": 987,
        "display_state_if_optional": true,
        "enable_multiple_wishlists": "abc123",
        "fixed_product_taxes_apply_tax_to_fpt": false,
        "fixed_product_taxes_display_prices_in_emails": 123,
        "fixed_product_taxes_display_prices_in_product_lists": 987,
        "fixed_product_taxes_display_prices_in_sales_modules": 987,
        "fixed_product_taxes_display_prices_on_product_view_page": 123,
        "fixed_product_taxes_enable": true,
        "fixed_product_taxes_include_fpt_in_subtotal": true,
        "graphql_share_customer_group": false,
        "grid_per_page": 123,
        "grid_per_page_values": "xyz789",
        "grouped_product_image": "ITSELF",
        "is_checkout_agreements_enabled": false,
        "is_default_store": true,
        "is_default_store_group": false,
        "is_guest_checkout_enabled": false,
        "is_negotiable_quote_active": false,
        "is_one_page_checkout_enabled": false,
        "is_requisition_list_active": "xyz789",
        "list_mode": "abc123",
        "list_per_page": 987,
        "list_per_page_values": "abc123",
        "locale": "xyz789",
        "magento_reward_general_is_enabled": "abc123",
        "magento_reward_general_is_enabled_on_front": "xyz789",
        "magento_reward_general_min_points_balance": "xyz789",
        "magento_reward_general_publish_history": "xyz789",
        "magento_reward_points_invitation_customer": "abc123",
        "magento_reward_points_invitation_customer_limit": "abc123",
        "magento_reward_points_invitation_order": "abc123",
        "magento_reward_points_invitation_order_limit": "abc123",
        "magento_reward_points_newsletter": "abc123",
        "magento_reward_points_order": "xyz789",
        "magento_reward_points_register": "xyz789",
        "magento_reward_points_review": "xyz789",
        "magento_reward_points_review_limit": "xyz789",
        "magento_wishlist_general_is_enabled": "abc123",
        "max_items_in_order_summary": 987,
        "maximum_number_of_wishlists": "abc123",
        "minicart_display": true,
        "minicart_max_items": 987,
        "minimum_password_length": "xyz789",
        "newsletter_enabled": false,
        "optional_zip_countries": "abc123",
        "order_cancellation_enabled": false,
        "order_cancellation_reasons": [
          CancellationReason
        ],
        "orders_invoices_credit_memos_display_full_summary": false,
        "orders_invoices_credit_memos_display_grandtotal": 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,
        "persistent_enabled": true,
        "persistent_options_wishlist": false,
        "persistent_shopping_cart": true,
        "printed_card_priceV2": Money,
        "product_alert_allow_stock": false,
        "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
        "product_url_suffix": "abc123",
        "quickorder_active": false,
        "quote_minimum_amount": 123.45,
        "quote_minimum_amount_message": "abc123",
        "required_character_classes_number": "abc123",
        "requisition_list_share_link_validity_days": 987,
        "requisition_list_share_max_recipients": 123,
        "requisition_list_share_storefront_path": "xyz789",
        "requisition_list_sharing_enabled": false,
        "returns_enabled": "xyz789",
        "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": "abc123",
        "secure_base_url": "xyz789",
        "share_active_segments": false,
        "share_applied_cart_rule": true,
        "share_customer_accounts_scope": 123,
        "shopping_assistance_checkbox_title": "xyz789",
        "shopping_assistance_checkbox_tooltip": "abc123",
        "shopping_assistance_enabled": true,
        "shopping_cart_display_full_summary": true,
        "shopping_cart_display_grand_total": false,
        "shopping_cart_display_price": 987,
        "shopping_cart_display_shipping": 987,
        "shopping_cart_display_subtotal": 987,
        "shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX",
        "shopping_cart_display_zero_tax": true,
        "store_code": "4",
        "store_group_code": "4",
        "store_group_name": "xyz789",
        "store_name": "abc123",
        "store_sort_order": 123,
        "timezone": "xyz789",
        "title_separator": "xyz789",
        "use_store_in_url": true,
        "website_code": "4",
        "website_name": "xyz789",
        "weight_unit": "xyz789",
        "zero_subtotal_enable_for_specific_countries": true,
        "zero_subtotal_enabled": false,
        "zero_subtotal_new_order_status": "abc123",
        "zero_subtotal_payment_action": "xyz789",
        "zero_subtotal_payment_from_specific_countries": "xyz789",
        "zero_subtotal_sort_order": 987,
        "zero_subtotal_title": "xyz789"
      }
    ]
  }
}

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_coupons {
      ...AppliedCouponFragment
    }
    applied_gift_cards {
      ...AppliedGiftCardFragment
    }
    applied_reward_points {
      ...RewardPointsAmountFragment
    }
    applied_store_credit {
      ...AppliedStoreCreditFragment
    }
    available_free_gifts {
      ...AvailableFreeGiftFragment
    }
    available_gift_wrappings {
      ...GiftWrappingFragment
    }
    available_payment_methods {
      ...AvailablePaymentMethodFragment
    }
    billing_address {
      ...BillingCartAddressFragment
    }
    custom_attributes {
      ...CustomAttributeFragment
    }
    email
    gift_message {
      ...GiftMessageFragment
    }
    gift_receipt_included
    gift_wrapping {
      ...GiftWrappingFragment
    }
    has_available_free_gifts
    id
    is_virtual
    itemsV2 {
      ...CartItemsFragment
    }
    prices {
      ...CartPricesFragment
    }
    printed_card_included
    rules {
      ...CartRuleStorefrontFragment
    }
    selected_payment_method {
      ...SelectedPaymentMethodFragment
    }
    shipping_addresses {
      ...ShippingCartAddressFragment
    }
    total_quantity
  }
}
Variables
{"cart_id": "xyz789"}
Response
{
  "data": {
    "cart": {
      "applied_coupons": [AppliedCoupon],
      "applied_gift_cards": [AppliedGiftCard],
      "applied_reward_points": RewardPointsAmount,
      "applied_store_credit": AppliedStoreCredit,
      "available_free_gifts": [AvailableFreeGift],
      "available_gift_wrappings": [GiftWrapping],
      "available_payment_methods": [
        AvailablePaymentMethod
      ],
      "billing_address": BillingCartAddress,
      "custom_attributes": [CustomAttribute],
      "email": "abc123",
      "gift_message": GiftMessage,
      "gift_receipt_included": true,
      "gift_wrapping": GiftWrapping,
      "has_available_free_gifts": true,
      "id": "4",
      "is_virtual": true,
      "itemsV2": CartItems,
      "prices": CartPrices,
      "printed_card_included": true,
      "rules": [CartRuleStorefront],
      "selected_payment_method": SelectedPaymentMethod,
      "shipping_addresses": [ShippingCartAddress],
      "total_quantity": 987.65
    }
  }
}

categories

Return category views by IDs, with optional role filters and subtree scopes. Available only for deployments using the Catalog or Live Search service with Adobe Commerce. For Adobe Commerce Optimizer, use the categoryTree query instead. See categoryTree query examples.

Response: [CategoryView]

Arguments

Name
Description
ids - [String!]
List of category IDs to retrieve. For example, 123, 456 or 789.
roles - [String!]
List of roles to filter the categories by. For example, show_on_plp, show_in_pdp or show_in_search.
subtree - Subtree
Subtree of the categories to retrieve. startLevel uses absolute category levels (root = 1). For example, depth: 1, startLevel: 1.

Example

Query
query categories(
  $ids: [String!],
  $roles: [String!],
  $subtree: Subtree
) {
  categories(
    ids: $ids,
    roles: $roles,
    subtree: $subtree
  ) {
    availableSortBy
    children
    defaultSortBy
    id
    level
    name
    parentId
    position
    path
    roles
    urlKey
    urlPath
    count
    title
  }
}
Variables
{
  "ids": ["xyz789"],
  "roles": ["xyz789"],
  "subtree": Subtree
}
Response
{
  "data": {
    "categories": [
      {
        "availableSortBy": ["xyz789"],
        "children": ["xyz789"],
        "defaultSortBy": "xyz789",
        "id": 4,
        "level": 987,
        "name": "xyz789",
        "parentId": "xyz789",
        "position": 987,
        "path": "xyz789",
        "roles": ["abc123"],
        "urlKey": "xyz789",
        "urlPath": "xyz789",
        "count": 987,
        "title": "xyz789"
      }
    ]
  }
}

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": "abc123",
        "is_html": true,
        "mode": "AUTO",
        "name": "abc123"
      }
    ]
  }
}

commerceOptimizer

Provide necessary information to build headless storefront when Adobe Commerce is connected to Commerce Optimizer.

Response: CommerceOptimizerContext!

Example

Query
query commerceOptimizer {
  commerceOptimizer {
    priceBookId
  }
}
Response
{
  "data": {
    "commerceOptimizer": {
      "priceBookId": "4"
    }
  }
}

company

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

Response: Company

Example

Query
query company {
  company {
    acl_resources {
      ...CompanyAclResourceFragment
    }
    addresses {
      ...CompanyAddressesFragment
    }
    available_payment_methods {
      ...AvailablePaymentMethodFragment
    }
    available_shipping_methods {
      ...CompanyAvailableShippingMethodFragment
    }
    company_admin {
      ...CustomerFragment
    }
    config {
      ...CompanyConfigFragment
    }
    credit {
      ...CompanyCreditFragment
    }
    credit_history {
      ...CompanyCreditHistoryFragment
    }
    custom_attributes {
      ...CustomAttributeFragment
    }
    default_billing_address {
      ...CompanyAddressFragment
    }
    default_shipping_address {
      ...CompanyAddressFragment
    }
    email
    id
    legal_address {
      ...CompanyLegalAddressFragment
    }
    legal_name
    name
    payment_methods
    reseller_id
    role {
      ...CompanyRoleFragment
    }
    roles {
      ...CompanyRolesFragment
    }
    sales_representative {
      ...CompanySalesRepresentativeFragment
    }
    status
    structure {
      ...CompanyStructureFragment
    }
    team {
      ...CompanyTeamFragment
    }
    user {
      ...CustomerFragment
    }
    users {
      ...CompanyUsersFragment
    }
    vat_tax_id
  }
}
Response
{
  "data": {
    "company": {
      "acl_resources": [CompanyAclResource],
      "addresses": CompanyAddresses,
      "available_payment_methods": [
        AvailablePaymentMethod
      ],
      "available_shipping_methods": [
        CompanyAvailableShippingMethod
      ],
      "company_admin": Customer,
      "config": CompanyConfig,
      "credit": CompanyCredit,
      "credit_history": CompanyCreditHistory,
      "custom_attributes": [CustomAttribute],
      "default_billing_address": CompanyAddress,
      "default_shipping_address": CompanyAddress,
      "email": "abc123",
      "id": 4,
      "legal_address": CompanyLegalAddress,
      "legal_name": "abc123",
      "name": "xyz789",
      "payment_methods": ["xyz789"],
      "reseller_id": "abc123",
      "role": CompanyRole,
      "roles": CompanyRoles,
      "sales_representative": CompanySalesRepresentative,
      "status": "PENDING",
      "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": 987,
      "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": "abc123",
        "full_name_locale": "abc123",
        "id": "xyz789",
        "three_letter_abbreviation": "xyz789",
        "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": "xyz789"}
Response
{
  "data": {
    "country": {
      "available_regions": [Region],
      "full_name_english": "abc123",
      "full_name_locale": "abc123",
      "id": "abc123",
      "three_letter_abbreviation": "xyz789",
      "two_letter_abbreviation": "abc123"
    }
  }
}

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_currency_code
    default_display_currency_symbol
    exchange_rates {
      ...ExchangeRateFragment
    }
  }
}
Response
{
  "data": {
    "currency": {
      "available_currency_codes": [
        "xyz789"
      ],
      "base_currency_code": "abc123",
      "base_currency_symbol": "abc123",
      "default_display_currency_code": "xyz789",
      "default_display_currency_symbol": "xyz789",
      "exchange_rates": [ExchangeRate]
    }
  }
}

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
    }
    admin_assistance_actions {
      ...AdminAssistanceActionsFragment
    }
    allow_remote_shopping_assistance
    companies {
      ...UserCompaniesOutputFragment
    }
    company_hierarchy {
      ...CompanyHierarchyFragment
    }
    compare_list {
      ...CompareListFragment
    }
    confirmation_status
    created_at
    custom_attributes {
      ...AttributeValueInterfaceFragment
    }
    date_of_birth
    default_billing
    default_shipping
    email
    firstname
    gender
    gift_registries {
      ...GiftRegistryFragment
    }
    gift_registry {
      ...GiftRegistryFragment
    }
    group {
      ...CustomerGroupStorefrontFragment
    }
    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
    quote_enabled
    requisition_lists {
      ...RequisitionListsFragment
    }
    return {
      ...ReturnFragment
    }
    returns {
      ...ReturnsFragment
    }
    reward_points {
      ...RewardPointsFragment
    }
    role {
      ...CompanyRoleFragment
    }
    segments {
      ...CustomerSegmentStorefrontFragment
    }
    status
    store_credit {
      ...CustomerStoreCreditFragment
    }
    structure_id
    suffix
    taxvat
    team {
      ...CompanyTeamFragment
    }
    telephone
    wishlist_v2 {
      ...WishlistFragment
    }
    wishlists {
      ...WishlistFragment
    }
  }
}
Response
{
  "data": {
    "customer": {
      "addresses": [CustomerAddress],
      "addressesV2": CustomerAddresses,
      "admin_assistance_actions": AdminAssistanceActions,
      "allow_remote_shopping_assistance": true,
      "companies": UserCompaniesOutput,
      "company_hierarchy": [CompanyHierarchy],
      "compare_list": CompareList,
      "confirmation_status": "ACCOUNT_CONFIRMED",
      "created_at": "xyz789",
      "custom_attributes": [AttributeValueInterface],
      "date_of_birth": "abc123",
      "default_billing": "xyz789",
      "default_shipping": "abc123",
      "email": "xyz789",
      "firstname": "abc123",
      "gender": 123,
      "gift_registries": [GiftRegistry],
      "gift_registry": GiftRegistry,
      "group": CustomerGroupStorefront,
      "id": "4",
      "is_subscribed": false,
      "job_title": "abc123",
      "lastname": "xyz789",
      "middlename": "abc123",
      "orders": CustomerOrders,
      "prefix": "abc123",
      "purchase_order": PurchaseOrder,
      "purchase_order_approval_rule": PurchaseOrderApprovalRule,
      "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata,
      "purchase_order_approval_rules": PurchaseOrderApprovalRules,
      "purchase_orders": PurchaseOrders,
      "purchase_orders_enabled": true,
      "quote_enabled": true,
      "requisition_lists": RequisitionLists,
      "return": Return,
      "returns": Returns,
      "reward_points": RewardPoints,
      "role": CompanyRole,
      "segments": [CustomerSegmentStorefront],
      "status": "ACTIVE",
      "store_credit": CustomerStoreCredit,
      "structure_id": 4,
      "suffix": "abc123",
      "taxvat": "abc123",
      "team": CompanyTeam,
      "telephone": "xyz789",
      "wishlist_v2": Wishlist,
      "wishlists": [Wishlist]
    }
  }
}

customerCart

Return information about the customer's shopping cart.

Response: Cart!

Example

Query
query customerCart {
  customerCart {
    applied_coupons {
      ...AppliedCouponFragment
    }
    applied_gift_cards {
      ...AppliedGiftCardFragment
    }
    applied_reward_points {
      ...RewardPointsAmountFragment
    }
    applied_store_credit {
      ...AppliedStoreCreditFragment
    }
    available_free_gifts {
      ...AvailableFreeGiftFragment
    }
    available_gift_wrappings {
      ...GiftWrappingFragment
    }
    available_payment_methods {
      ...AvailablePaymentMethodFragment
    }
    billing_address {
      ...BillingCartAddressFragment
    }
    custom_attributes {
      ...CustomAttributeFragment
    }
    email
    gift_message {
      ...GiftMessageFragment
    }
    gift_receipt_included
    gift_wrapping {
      ...GiftWrappingFragment
    }
    has_available_free_gifts
    id
    is_virtual
    itemsV2 {
      ...CartItemsFragment
    }
    prices {
      ...CartPricesFragment
    }
    printed_card_included
    rules {
      ...CartRuleStorefrontFragment
    }
    selected_payment_method {
      ...SelectedPaymentMethodFragment
    }
    shipping_addresses {
      ...ShippingCartAddressFragment
    }
    total_quantity
  }
}
Response
{
  "data": {
    "customerCart": {
      "applied_coupons": [AppliedCoupon],
      "applied_gift_cards": [AppliedGiftCard],
      "applied_reward_points": RewardPointsAmount,
      "applied_store_credit": AppliedStoreCredit,
      "available_free_gifts": [AvailableFreeGift],
      "available_gift_wrappings": [GiftWrapping],
      "available_payment_methods": [
        AvailablePaymentMethod
      ],
      "billing_address": BillingCartAddress,
      "custom_attributes": [CustomAttribute],
      "email": "xyz789",
      "gift_message": GiftMessage,
      "gift_receipt_included": false,
      "gift_wrapping": GiftWrapping,
      "has_available_free_gifts": true,
      "id": "4",
      "is_virtual": false,
      "itemsV2": CartItems,
      "prices": CartPrices,
      "printed_card_included": false,
      "rules": [CartRuleStorefront],
      "selected_payment_method": SelectedPaymentMethod,
      "shipping_addresses": [ShippingCartAddress],
      "total_quantity": 123.45
    }
  }
}

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"}}}

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"}]
  }
}

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

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": "xyz789",
      "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": "xyz789",
      "owner_name": "xyz789",
      "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": "abc123"}
Response
{
  "data": {
    "giftRegistryEmailSearch": [
      {
        "event_date": "abc123",
        "event_title": "abc123",
        "gift_registry_uid": "4",
        "location": "abc123",
        "name": "abc123",
        "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": "abc123",
        "event_title": "xyz789",
        "gift_registry_uid": 4,
        "location": "abc123",
        "name": "xyz789",
        "type": "xyz789"
      }
    ]
  }
}

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": "xyz789",
  "lastName": "abc123",
  "giftRegistryTypeUid": 4
}
Response
{
  "data": {
    "giftRegistryTypeSearch": [
      {
        "event_date": "xyz789",
        "event_title": "xyz789",
        "gift_registry_uid": "4",
        "location": "xyz789",
        "name": "xyz789",
        "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) {
    admin_assisted_order
    applied_coupons {
      ...AppliedCouponFragment
    }
    applied_gift_cards {
      ...ApplyGiftCardToOrderFragment
    }
    available_actions
    billing_address {
      ...OrderAddressFragment
    }
    carrier
    comments {
      ...SalesCommentItemFragment
    }
    credit_memos {
      ...CreditMemoFragment
    }
    custom_attributes {
      ...CustomAttributeFragment
    }
    customer_info {
      ...OrderCustomerInfoFragment
    }
    email
    gift_message {
      ...GiftMessageFragment
    }
    gift_receipt_included
    gift_wrapping {
      ...GiftWrappingFragment
    }
    id
    invoices {
      ...InvoiceFragment
    }
    is_virtual
    items {
      ...OrderItemInterfaceFragment
    }
    items_eligible_for_return {
      ...OrderItemInterfaceFragment
    }
    negotiable_quote {
      ...NegotiableQuoteFragment
    }
    number
    order_date
    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": {
      "admin_assisted_order": 123,
      "applied_coupons": [AppliedCoupon],
      "applied_gift_cards": [ApplyGiftCardToOrder],
      "available_actions": ["REORDER"],
      "billing_address": OrderAddress,
      "carrier": "abc123",
      "comments": [SalesCommentItem],
      "credit_memos": [CreditMemo],
      "custom_attributes": [CustomAttribute],
      "customer_info": OrderCustomerInfo,
      "email": "abc123",
      "gift_message": GiftMessage,
      "gift_receipt_included": true,
      "gift_wrapping": GiftWrapping,
      "id": "4",
      "invoices": [Invoice],
      "is_virtual": true,
      "items": [OrderItemInterface],
      "items_eligible_for_return": [OrderItemInterface],
      "negotiable_quote": NegotiableQuote,
      "number": "abc123",
      "order_date": "abc123",
      "order_status_change_date": "abc123",
      "payment_methods": [OrderPaymentMethod],
      "printed_card_included": false,
      "returns": Returns,
      "shipments": [OrderShipment],
      "shipping_address": OrderAddress,
      "shipping_method": "xyz789",
      "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) {
    admin_assisted_order
    applied_coupons {
      ...AppliedCouponFragment
    }
    applied_gift_cards {
      ...ApplyGiftCardToOrderFragment
    }
    available_actions
    billing_address {
      ...OrderAddressFragment
    }
    carrier
    comments {
      ...SalesCommentItemFragment
    }
    credit_memos {
      ...CreditMemoFragment
    }
    custom_attributes {
      ...CustomAttributeFragment
    }
    customer_info {
      ...OrderCustomerInfoFragment
    }
    email
    gift_message {
      ...GiftMessageFragment
    }
    gift_receipt_included
    gift_wrapping {
      ...GiftWrappingFragment
    }
    id
    invoices {
      ...InvoiceFragment
    }
    is_virtual
    items {
      ...OrderItemInterfaceFragment
    }
    items_eligible_for_return {
      ...OrderItemInterfaceFragment
    }
    negotiable_quote {
      ...NegotiableQuoteFragment
    }
    number
    order_date
    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": {
      "admin_assisted_order": 987,
      "applied_coupons": [AppliedCoupon],
      "applied_gift_cards": [ApplyGiftCardToOrder],
      "available_actions": ["REORDER"],
      "billing_address": OrderAddress,
      "carrier": "abc123",
      "comments": [SalesCommentItem],
      "credit_memos": [CreditMemo],
      "custom_attributes": [CustomAttribute],
      "customer_info": OrderCustomerInfo,
      "email": "abc123",
      "gift_message": GiftMessage,
      "gift_receipt_included": true,
      "gift_wrapping": GiftWrapping,
      "id": 4,
      "invoices": [Invoice],
      "is_virtual": false,
      "items": [OrderItemInterface],
      "items_eligible_for_return": [OrderItemInterface],
      "negotiable_quote": NegotiableQuote,
      "number": "abc123",
      "order_date": "xyz789",
      "order_status_change_date": "xyz789",
      "payment_methods": [OrderPaymentMethod],
      "printed_card_included": true,
      "returns": Returns,
      "shipments": [OrderShipment],
      "shipping_address": OrderAddress,
      "shipping_method": "xyz789",
      "status": "abc123",
      "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": "abc123"}
Response
{"data": {"isCompanyAdminEmailAvailable": {"is_email_available": false}}}

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": "xyz789"}
Response
{"data": {"isCompanyEmailAvailable": {"is_email_available": false}}}

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

isSubscribedProductAlertPrice

Check if logged-in customer is subscribed to price alert for a product.

Response: IsProductAlertSubscriptionResult!

Arguments

Name
Description
input - ProductAlertPriceInput!

Example

Query
query isSubscribedProductAlertPrice($input: ProductAlertPriceInput!) {
  isSubscribedProductAlertPrice(input: $input) {
    isSubscribed
    message
  }
}
Variables
{"input": ProductAlertPriceInput}
Response
{
  "data": {
    "isSubscribedProductAlertPrice": {
      "isSubscribed": true,
      "message": "abc123"
    }
  }
}

isSubscribedProductAlertStock

Check if logged-in customer is subscribed to stock alert for a product.

Response: IsProductAlertSubscriptionResult!

Arguments

Name
Description
input - ProductAlertStockInput!

Example

Query
query isSubscribedProductAlertStock($input: ProductAlertStockInput!) {
  isSubscribedProductAlertStock(input: $input) {
    isSubscribed
    message
  }
}
Variables
{"input": ProductAlertStockInput}
Response
{
  "data": {
    "isSubscribedProductAlertStock": {
      "isSubscribed": true,
      "message": "abc123"
    }
  }
}

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
    custom_attributes {
      ...CustomAttributeFragment
    }
    email
    expiration_date
    history {
      ...NegotiableQuoteHistoryEntryFragment
    }
    is_virtual
    items {
      ...CartItemInterfaceFragment
    }
    name
    order {
      ...CustomerOrderFragment
    }
    prices {
      ...CartPricesFragment
    }
    sales_rep_name
    selected_payment_method {
      ...SelectedPaymentMethodFragment
    }
    shipping_addresses {
      ...NegotiableQuoteShippingAddressFragment
    }
    status
    template_id
    template_name
    total_quantity
    uid
    updated_at
  }
}
Variables
{"uid": "4"}
Response
{
  "data": {
    "negotiableQuote": {
      "available_payment_methods": [
        AvailablePaymentMethod
      ],
      "billing_address": NegotiableQuoteBillingAddress,
      "buyer": NegotiableQuoteUser,
      "comments": [NegotiableQuoteComment],
      "created_at": "abc123",
      "custom_attributes": [CustomAttribute],
      "email": "abc123",
      "expiration_date": "xyz789",
      "history": [NegotiableQuoteHistoryEntry],
      "is_virtual": false,
      "items": [CartItemInterface],
      "name": "abc123",
      "order": CustomerOrder,
      "prices": CartPrices,
      "sales_rep_name": "abc123",
      "selected_payment_method": SelectedPaymentMethod,
      "shipping_addresses": [
        NegotiableQuoteShippingAddress
      ],
      "status": "SUBMITTED",
      "template_id": 4,
      "template_name": "abc123",
      "total_quantity": 123.45,
      "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
    }
    created_at
    expiration_date
    history {
      ...NegotiableQuoteHistoryEntryFragment
    }
    historyV2 {
      ...NegotiableQuoteTemplateHistoryEntryFragment
    }
    is_min_max_qty_used
    is_virtual
    items {
      ...CartItemInterfaceFragment
    }
    max_order_commitment
    min_order_commitment
    name
    notifications {
      ...QuoteTemplateNotificationMessageFragment
    }
    prices {
      ...CartPricesFragment
    }
    reference_document_links {
      ...NegotiableQuoteReferenceDocumentLinkFragment
    }
    sales_rep_name
    shipping_addresses {
      ...NegotiableQuoteShippingAddressFragment
    }
    status
    template_id
    total_quantity
    uid
    updated_at
  }
}
Variables
{"templateId": 4}
Response
{
  "data": {
    "negotiableQuoteTemplate": {
      "buyer": NegotiableQuoteUser,
      "comments": [NegotiableQuoteComment],
      "created_at": "abc123",
      "expiration_date": "abc123",
      "history": [NegotiableQuoteHistoryEntry],
      "historyV2": [NegotiableQuoteTemplateHistoryEntry],
      "is_min_max_qty_used": false,
      "is_virtual": true,
      "items": [CartItemInterface],
      "max_order_commitment": 123,
      "min_order_commitment": 987,
      "name": "abc123",
      "notifications": [QuoteTemplateNotificationMessage],
      "prices": CartPrices,
      "reference_document_links": [
        NegotiableQuoteReferenceDocumentLink
      ],
      "sales_rep_name": "abc123",
      "shipping_addresses": [
        NegotiableQuoteShippingAddress
      ],
      "status": "xyz789",
      "template_id": 4,
      "total_quantity": 123.45,
      "uid": 4,
      "updated_at": "xyz789"
    }
  }
}

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": 987
    }
  }
}

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": 987
    }
  }
}

payByLinkCart

Resolve a Pay By Link token to the masked id of the guest cart to resume checkout against.

Response: PayByLinkCartOutput

Arguments

Name
Description
token - String!
The Pay By Link token from the emailed link.

Example

Query
query payByLinkCart($token: String!) {
  payByLinkCart(token: $token) {
    masked_cart_id
  }
}
Variables
{"token": "abc123"}
Response
{
  "data": {
    "payByLinkCart": {
      "masked_cart_id": "abc123"
    }
  }
}

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

productSearch

Search products using Live Search

Response: ProductSearchResponse!

Arguments

Name
Description
context - QueryContextInput
The query context
current_page - Int
Specifies which page of results to return. The default value is 1 Default: 1
filter - [SearchClauseInput!]
Identifies product attributes and conditions to filter on
page_size - Int
The maximum number of results to return at once Default: 20
phrase - String!
Phrase to search for in product catalog
sort - [ProductSearchSortInput!]
Attributes and direction to sort on

Example

Query
query productSearch(
  $context: QueryContextInput,
  $current_page: Int,
  $filter: [SearchClauseInput!],
  $page_size: Int,
  $phrase: String!,
  $sort: [ProductSearchSortInput!]
) {
  productSearch(
    context: $context,
    current_page: $current_page,
    filter: $filter,
    page_size: $page_size,
    phrase: $phrase,
    sort: $sort
  ) {
    facets {
      ...AggregationFragment
    }
    items {
      ...ProductSearchItemFragment
    }
    page_info {
      ...SearchResultPageInfoFragment
    }
    related_terms
    suggestions
    total_count
    warnings {
      ...ProductSearchWarningFragment
    }
  }
}
Variables
{
  "context": QueryContextInput,
  "current_page": 1,
  "filter": [SearchClauseInput],
  "page_size": 20,
  "phrase": "xyz789",
  "sort": [ProductSearchSortInput]
}
Response
{
  "data": {
    "productSearch": {
      "facets": [Aggregation],
      "items": [ProductSearchItem],
      "page_info": SearchResultPageInfo,
      "related_terms": ["abc123"],
      "suggestions": ["xyz789"],
      "total_count": 987,
      "warnings": [ProductSearchWarning]
    }
  }
}

products

Search for products that match the specified SKU values. Available only for deployments using the Catalog or Live Search service with Adobe Commerce.

Response: [ProductView]

Arguments

Name
Description
skus - [String]
List of SKUs to search for. For example, 123, 456 or 789.

Example

Query
query products($skus: [String]) {
  products(skus: $skus) {
    addToCartAllowed
    inStock
    lowStock
    attributes {
      ...ProductViewAttributeFragment
    }
    description
    id
    images {
      ...ProductViewImageFragment
    }
    videos {
      ...ProductViewVideoFragment
    }
    lastModifiedAt
    metaDescription
    metaKeyword
    metaTitle
    name
    shortDescription
    inputOptions {
      ...ProductViewInputOptionFragment
    }
    sku
    externalId
    externalIds {
      ...ExternalIdFragment
    }
    url
    urlKey
    links {
      ...ProductViewLinkFragment
    }
    queryType
    visibility
  }
}
Variables
{"skus": ["abc123"]}
Response
{
  "data": {
    "products": [
      {
        "addToCartAllowed": false,
        "inStock": false,
        "lowStock": true,
        "attributes": [ProductViewAttribute],
        "description": "xyz789",
        "id": 4,
        "images": [ProductViewImage],
        "videos": [ProductViewVideo],
        "lastModifiedAt": "2007-12-03T10:15:30Z",
        "metaDescription": "xyz789",
        "metaKeyword": "abc123",
        "metaTitle": "abc123",
        "name": "xyz789",
        "shortDescription": "xyz789",
        "inputOptions": [ProductViewInputOption],
        "sku": "abc123",
        "externalId": "abc123",
        "externalIds": [ExternalId],
        "url": "xyz789",
        "urlKey": "abc123",
        "links": [ProductViewLink],
        "queryType": "xyz789",
        "visibility": "abc123"
      }
    ]
  }
}

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": true
    }
  }
}

recaptchaFormConfigs

Returns reCAPTCHA configuration details for multiple form types in a single request.

Response: [ReCaptchaFormConfigItem]

Arguments

Name
Description
formTypes - [ReCaptchaFormEnum!]!

Example

Query
query recaptchaFormConfigs($formTypes: [ReCaptchaFormEnum!]!) {
  recaptchaFormConfigs(formTypes: $formTypes) {
    configurations {
      ...ReCaptchaConfigurationFragment
    }
    form_type
    is_enabled
  }
}
Variables
{"formTypes": ["PLACE_ORDER"]}
Response
{
  "data": {
    "recaptchaFormConfigs": [
      {
        "configurations": ReCaptchaConfiguration,
        "form_type": "PLACE_ORDER",
        "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": "abc123",
      "failure_message": "xyz789",
      "forms": ["PLACE_ORDER"],
      "is_enabled": false,
      "language_code": "abc123",
      "minimum_score": 123.45,
      "theme": "abc123",
      "website_key": "abc123"
    }
  }
}

recommendations

Get Recommendations

Response: Recommendations

Arguments

Name
Description
cartSkus - [String]
SKUs of products in the cart
category - String
Category currently being viewed
currentSku - String
SKU of the product currently being viewed on PDP
currentProduct - CurrentProductInput
Current product context from PDP (SKU, price, category, etc.)
pageType - PageType
Type of page on which recommendations are requested
userPurchaseHistory - [PurchaseHistory]
User purchase history with timestamp
userViewHistory - [ViewHistory]
User view history with timestamp
config - UnitConfigInput
Optional unit configuration

Example

Query
query recommendations(
  $cartSkus: [String],
  $category: String,
  $currentSku: String,
  $currentProduct: CurrentProductInput,
  $pageType: PageType,
  $userPurchaseHistory: [PurchaseHistory],
  $userViewHistory: [ViewHistory],
  $config: UnitConfigInput
) {
  recommendations(
    cartSkus: $cartSkus,
    category: $category,
    currentSku: $currentSku,
    currentProduct: $currentProduct,
    pageType: $pageType,
    userPurchaseHistory: $userPurchaseHistory,
    userViewHistory: $userViewHistory,
    config: $config
  ) {
    results {
      ...RecommendationUnitFragment
    }
    totalResults
  }
}
Variables
{
  "cartSkus": ["abc123"],
  "category": "abc123",
  "currentSku": "abc123",
  "currentProduct": CurrentProductInput,
  "pageType": "CMS",
  "userPurchaseHistory": [PurchaseHistory],
  "userViewHistory": [ViewHistory],
  "config": UnitConfigInput
}
Response
{
  "data": {
    "recommendations": {
      "results": [RecommendationUnit],
      "totalResults": 123
    }
  }
}

recommendationsByUnits

Response: Recommendations

Arguments

Name
Description
selector - UnitSelector!
Selector of preconfigured units
currentSku - String
SKU of the product currently being viewed on PDP
currentProduct - CurrentProductInput
Current product context from PDP (SKU, price, category, etc.)
userPurchaseHistory - [PurchaseHistory]
User purchase history with timestamp
userViewHistory - [ViewHistory]
User view history with timestamp
cartSkus - [String]
SKUs of products in the cart

Example

Query
query recommendationsByUnits(
  $selector: UnitSelector!,
  $currentSku: String,
  $currentProduct: CurrentProductInput,
  $userPurchaseHistory: [PurchaseHistory],
  $userViewHistory: [ViewHistory],
  $cartSkus: [String]
) {
  recommendationsByUnits(
    selector: $selector,
    currentSku: $currentSku,
    currentProduct: $currentProduct,
    userPurchaseHistory: $userPurchaseHistory,
    userViewHistory: $userViewHistory,
    cartSkus: $cartSkus
  ) {
    results {
      ...RecommendationUnitFragment
    }
    totalResults
  }
}
Variables
{
  "selector": UnitSelector,
  "currentSku": "xyz789",
  "currentProduct": CurrentProductInput,
  "userPurchaseHistory": [PurchaseHistory],
  "userViewHistory": [ViewHistory],
  "cartSkus": ["abc123"]
}
Response
{
  "data": {
    "recommendationsByUnits": {
      "results": [RecommendationUnit],
      "totalResults": 987
    }
  }
}

refineProduct

Narrow down the results of a products query that was run against a complex product. Specify option IDs and SKUs to refine the product.

Response: ProductView

Arguments

Name
Description
optionIds - [String!]!
List of option IDs to refine the product by. For example, 123, 456 or 789.
sku - String!
SKU of the product to refine. For example, RF903, DG90-54 or 789-001.

Example

Query
query refineProduct(
  $optionIds: [String!]!,
  $sku: String!
) {
  refineProduct(
    optionIds: $optionIds,
    sku: $sku
  ) {
    addToCartAllowed
    inStock
    lowStock
    attributes {
      ...ProductViewAttributeFragment
    }
    description
    id
    images {
      ...ProductViewImageFragment
    }
    videos {
      ...ProductViewVideoFragment
    }
    lastModifiedAt
    metaDescription
    metaKeyword
    metaTitle
    name
    shortDescription
    inputOptions {
      ...ProductViewInputOptionFragment
    }
    sku
    externalId
    externalIds {
      ...ExternalIdFragment
    }
    url
    urlKey
    links {
      ...ProductViewLinkFragment
    }
    queryType
    visibility
  }
}
Variables
{
  "optionIds": ["abc123"],
  "sku": "abc123"
}
Response
{
  "data": {
    "refineProduct": {
      "addToCartAllowed": true,
      "inStock": false,
      "lowStock": true,
      "attributes": [ProductViewAttribute],
      "description": "abc123",
      "id": "4",
      "images": [ProductViewImage],
      "videos": [ProductViewVideo],
      "lastModifiedAt": "2007-12-03T10:15:30Z",
      "metaDescription": "xyz789",
      "metaKeyword": "abc123",
      "metaTitle": "xyz789",
      "name": "abc123",
      "shortDescription": "xyz789",
      "inputOptions": [ProductViewInputOption],
      "sku": "xyz789",
      "externalId": "xyz789",
      "externalIds": [ExternalId],
      "url": "xyz789",
      "urlKey": "abc123",
      "links": [ProductViewLink],
      "queryType": "abc123",
      "visibility": "xyz789"
    }
  }
}

sharedRequisitionList

View a shared requisition list when the receiver is logged in and belongs to the same company as the sender.

Response: SharedRequisitionListOutput

Arguments

Name
Description
token - String!
The share token which is extracted from the requisition list share link and acts as an identifier for the requisition list.

Example

Query
query sharedRequisitionList($token: String!) {
  sharedRequisitionList(token: $token) {
    requisition_list {
      ...RequisitionListFragment
    }
    sender_name
  }
}
Variables
{"token": "xyz789"}
Response
{
  "data": {
    "sharedRequisitionList": {
      "requisition_list": RequisitionList,
      "sender_name": "xyz789"
    }
  }
}

sourceAvailability

Per-source availability for one or more SKUs, scoped to the storefront-visible sources of the current sales channel's stock. Availability is computed identically to the order-placement guard.

Response: [SkuSourceAvailability]!

Arguments

Name
Description
skus - [String!]!
The product SKUs to report availability for.
source_codes - [String!]
Restrict the report to these inventory sources. Only sources flagged storefront-visible are ever reported; a requested source that is not storefront-visible, or not assigned to the current sales channel's stock, is silently omitted. When omitted, every storefront-visible source assigned to the current sales channel's stock is reported.
only_in_stock - Boolean
When true, omit sources where the SKU is not salable.

Example

Query
query sourceAvailability(
  $skus: [String!]!,
  $source_codes: [String!],
  $only_in_stock: Boolean
) {
  sourceAvailability(
    skus: $skus,
    source_codes: $source_codes,
    only_in_stock: $only_in_stock
  ) {
    sku
    sources {
      ...SourceAvailabilityFragment
    }
  }
}
Variables
{
  "skus": ["xyz789"],
  "source_codes": ["abc123"],
  "only_in_stock": false
}
Response
{
  "data": {
    "sourceAvailability": [
      {
        "sku": "abc123",
        "sources": [SourceAvailability]
      }
    ]
  }
}

storeConfig

Return details about the store's configuration.

Response: StoreConfig

Example

Query
query storeConfig {
  storeConfig {
    allow_company_registration
    allow_gift_receipt
    allow_gift_wrapping_on_order
    allow_gift_wrapping_on_order_items
    allow_items
    allow_order
    allow_printed_card
    autocomplete_on_storefront
    base_currency_code
    base_link_url
    base_media_url
    base_static_url
    base_url
    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
    company_credit_enabled
    company_enabled
    configurable_product_image
    configurable_thumbnail_source
    contact_enabled
    countries_with_required_region
    create_account_confirmation
    customer_access_token_lifetime
    default_country
    default_display_currency_code
    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
    graphql_share_customer_group
    grid_per_page
    grid_per_page_values
    grouped_product_image
    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
    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
    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
    persistent_enabled
    persistent_options_wishlist
    persistent_shopping_cart
    printed_card_priceV2 {
      ...MoneyFragment
    }
    product_alert_allow_stock
    product_fixed_product_tax_display_setting
    product_url_suffix
    quickorder_active
    quote_minimum_amount
    quote_minimum_amount_message
    required_character_classes_number
    requisition_list_share_link_validity_days
    requisition_list_share_max_recipients
    requisition_list_share_storefront_path
    requisition_list_sharing_enabled
    returns_enabled
    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
    share_active_segments
    share_applied_cart_rule
    share_customer_accounts_scope
    shopping_assistance_checkbox_title
    shopping_assistance_checkbox_tooltip
    shopping_assistance_enabled
    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
    store_code
    store_group_code
    store_group_name
    store_name
    store_sort_order
    timezone
    title_separator
    use_store_in_url
    website_code
    website_name
    weight_unit
    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": {
      "allow_company_registration": false,
      "allow_gift_receipt": "abc123",
      "allow_gift_wrapping_on_order": "xyz789",
      "allow_gift_wrapping_on_order_items": "abc123",
      "allow_items": "abc123",
      "allow_order": "xyz789",
      "allow_printed_card": "xyz789",
      "autocomplete_on_storefront": true,
      "base_currency_code": "abc123",
      "base_link_url": "abc123",
      "base_media_url": "abc123",
      "base_static_url": "xyz789",
      "base_url": "abc123",
      "cart_expires_in_days": 123,
      "cart_gift_wrapping": "abc123",
      "cart_merge_preference": "xyz789",
      "cart_printed_card": "xyz789",
      "cart_summary_display_quantity": 123,
      "catalog_default_sort_by": "xyz789",
      "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
      "category_url_suffix": "xyz789",
      "check_money_order_enable_for_specific_countries": false,
      "check_money_order_enabled": true,
      "check_money_order_make_check_payable_to": "xyz789",
      "check_money_order_max_order_total": "abc123",
      "check_money_order_min_order_total": "abc123",
      "check_money_order_new_order_status": "xyz789",
      "check_money_order_payment_from_specific_countries": "abc123",
      "check_money_order_send_check_to": "abc123",
      "check_money_order_sort_order": 987,
      "check_money_order_title": "xyz789",
      "company_credit_enabled": false,
      "company_enabled": false,
      "configurable_product_image": "ITSELF",
      "configurable_thumbnail_source": "xyz789",
      "contact_enabled": false,
      "countries_with_required_region": "abc123",
      "create_account_confirmation": false,
      "customer_access_token_lifetime": 123.45,
      "default_country": "abc123",
      "default_display_currency_code": "abc123",
      "display_product_prices_in_catalog": 123,
      "display_shipping_prices": 123,
      "display_state_if_optional": false,
      "enable_multiple_wishlists": "xyz789",
      "fixed_product_taxes_apply_tax_to_fpt": true,
      "fixed_product_taxes_display_prices_in_emails": 987,
      "fixed_product_taxes_display_prices_in_product_lists": 123,
      "fixed_product_taxes_display_prices_in_sales_modules": 123,
      "fixed_product_taxes_display_prices_on_product_view_page": 123,
      "fixed_product_taxes_enable": true,
      "fixed_product_taxes_include_fpt_in_subtotal": false,
      "graphql_share_customer_group": true,
      "grid_per_page": 987,
      "grid_per_page_values": "xyz789",
      "grouped_product_image": "ITSELF",
      "is_checkout_agreements_enabled": false,
      "is_default_store": false,
      "is_default_store_group": false,
      "is_guest_checkout_enabled": true,
      "is_negotiable_quote_active": false,
      "is_one_page_checkout_enabled": false,
      "is_requisition_list_active": "xyz789",
      "list_mode": "xyz789",
      "list_per_page": 123,
      "list_per_page_values": "abc123",
      "locale": "xyz789",
      "magento_reward_general_is_enabled": "abc123",
      "magento_reward_general_is_enabled_on_front": "abc123",
      "magento_reward_general_min_points_balance": "xyz789",
      "magento_reward_general_publish_history": "abc123",
      "magento_reward_points_invitation_customer": "xyz789",
      "magento_reward_points_invitation_customer_limit": "xyz789",
      "magento_reward_points_invitation_order": "xyz789",
      "magento_reward_points_invitation_order_limit": "xyz789",
      "magento_reward_points_newsletter": "xyz789",
      "magento_reward_points_order": "xyz789",
      "magento_reward_points_register": "abc123",
      "magento_reward_points_review": "xyz789",
      "magento_reward_points_review_limit": "xyz789",
      "magento_wishlist_general_is_enabled": "abc123",
      "max_items_in_order_summary": 987,
      "maximum_number_of_wishlists": "abc123",
      "minicart_display": false,
      "minicart_max_items": 987,
      "minimum_password_length": "xyz789",
      "newsletter_enabled": false,
      "optional_zip_countries": "abc123",
      "order_cancellation_enabled": false,
      "order_cancellation_reasons": [CancellationReason],
      "orders_invoices_credit_memos_display_full_summary": false,
      "orders_invoices_credit_memos_display_grandtotal": false,
      "orders_invoices_credit_memos_display_price": 123,
      "orders_invoices_credit_memos_display_shipping_amount": 123,
      "orders_invoices_credit_memos_display_subtotal": 123,
      "orders_invoices_credit_memos_display_zero_tax": true,
      "persistent_enabled": false,
      "persistent_options_wishlist": true,
      "persistent_shopping_cart": true,
      "printed_card_priceV2": Money,
      "product_alert_allow_stock": false,
      "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
      "product_url_suffix": "abc123",
      "quickorder_active": true,
      "quote_minimum_amount": 987.65,
      "quote_minimum_amount_message": "abc123",
      "required_character_classes_number": "abc123",
      "requisition_list_share_link_validity_days": 987,
      "requisition_list_share_max_recipients": 987,
      "requisition_list_share_storefront_path": "abc123",
      "requisition_list_sharing_enabled": false,
      "returns_enabled": "abc123",
      "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": "xyz789",
      "secure_base_static_url": "xyz789",
      "secure_base_url": "abc123",
      "share_active_segments": true,
      "share_applied_cart_rule": false,
      "share_customer_accounts_scope": 123,
      "shopping_assistance_checkbox_title": "xyz789",
      "shopping_assistance_checkbox_tooltip": "xyz789",
      "shopping_assistance_enabled": false,
      "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": false,
      "store_code": "4",
      "store_group_code": "4",
      "store_group_name": "xyz789",
      "store_name": "xyz789",
      "store_sort_order": 987,
      "timezone": "abc123",
      "title_separator": "xyz789",
      "use_store_in_url": false,
      "website_code": "4",
      "website_name": "abc123",
      "weight_unit": "xyz789",
      "zero_subtotal_enable_for_specific_countries": false,
      "zero_subtotal_enabled": false,
      "zero_subtotal_new_order_status": "abc123",
      "zero_subtotal_payment_action": "xyz789",
      "zero_subtotal_payment_from_specific_countries": "abc123",
      "zero_subtotal_sort_order": 123,
      "zero_subtotal_title": "abc123"
    }
  }
}

variants

Response: ProductViewVariantResults

Arguments

Name
Description
sku - String!
SKU of the product to get variants for. For example, UR123, MZ456 or KS789.
optionIds - [String!]
List of option IDs to get variants for. For example, 123, 456 or 789.
pageSize - Int
Page size for pagination. For example, 10 for a page size of 10 or 20 for a page size of 20.
cursor - String
Pagination cursor. For example, 123 for the first variant, 456 for the second variant.

Example

Query
query variants(
  $sku: String!,
  $optionIds: [String!],
  $pageSize: Int,
  $cursor: String
) {
  variants(
    sku: $sku,
    optionIds: $optionIds,
    pageSize: $pageSize,
    cursor: $cursor
  ) {
    variants {
      ...ProductViewVariantFragment
    }
    cursor
  }
}
Variables
{
  "sku": "xyz789",
  "optionIds": ["abc123"],
  "pageSize": 987,
  "cursor": "xyz789"
}
Response
{
  "data": {
    "variants": {
      "variants": [ProductViewVariant],
      "cursor": "abc123"
    }
  }
}