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

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

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

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
    printed_card_priceV2 {
      ...MoneyFragment
    }
    product_fixed_product_tax_display_setting
    product_url_suffix
    quickorder_active
    quote_minimum_amount
    quote_minimum_amount_message
    required_character_classes_number
    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
    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": "xyz789",
        "allow_gift_wrapping_on_order_items": "abc123",
        "allow_items": "xyz789",
        "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": "abc123",
        "base_url": "xyz789",
        "cart_expires_in_days": 987,
        "cart_gift_wrapping": "xyz789",
        "cart_merge_preference": "xyz789",
        "cart_printed_card": "xyz789",
        "cart_summary_display_quantity": 987,
        "catalog_default_sort_by": "abc123",
        "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
        "category_url_suffix": "xyz789",
        "check_money_order_enable_for_specific_countries": false,
        "check_money_order_enabled": false,
        "check_money_order_make_check_payable_to": "xyz789",
        "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": "xyz789",
        "check_money_order_send_check_to": "abc123",
        "check_money_order_sort_order": 987,
        "check_money_order_title": "xyz789",
        "company_credit_enabled": true,
        "company_enabled": true,
        "configurable_product_image": "ITSELF",
        "configurable_thumbnail_source": "abc123",
        "contact_enabled": false,
        "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": 123,
        "display_state_if_optional": true,
        "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": 987,
        "fixed_product_taxes_display_prices_on_product_view_page": 987,
        "fixed_product_taxes_enable": false,
        "fixed_product_taxes_include_fpt_in_subtotal": false,
        "graphql_share_customer_group": false,
        "grid_per_page": 123,
        "grid_per_page_values": "abc123",
        "grouped_product_image": "ITSELF",
        "is_checkout_agreements_enabled": true,
        "is_default_store": false,
        "is_default_store_group": false,
        "is_guest_checkout_enabled": true,
        "is_negotiable_quote_active": false,
        "is_one_page_checkout_enabled": true,
        "is_requisition_list_active": "abc123",
        "list_mode": "abc123",
        "list_per_page": 123,
        "list_per_page_values": "abc123",
        "locale": "abc123",
        "magento_reward_general_is_enabled": "abc123",
        "magento_reward_general_is_enabled_on_front": "xyz789",
        "magento_reward_general_min_points_balance": "abc123",
        "magento_reward_general_publish_history": "xyz789",
        "magento_reward_points_invitation_customer": "xyz789",
        "magento_reward_points_invitation_customer_limit": "abc123",
        "magento_reward_points_invitation_order": "abc123",
        "magento_reward_points_invitation_order_limit": "abc123",
        "magento_reward_points_newsletter": "xyz789",
        "magento_reward_points_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": 123,
        "maximum_number_of_wishlists": "abc123",
        "minicart_display": false,
        "minicart_max_items": 987,
        "minimum_password_length": "abc123",
        "newsletter_enabled": false,
        "optional_zip_countries": "abc123",
        "order_cancellation_enabled": true,
        "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": 123,
        "orders_invoices_credit_memos_display_shipping_amount": 123,
        "orders_invoices_credit_memos_display_subtotal": 987,
        "orders_invoices_credit_memos_display_zero_tax": true,
        "printed_card_priceV2": Money,
        "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": "xyz789",
        "required_character_classes_number": "abc123",
        "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": "xyz789",
        "secure_base_media_url": "xyz789",
        "secure_base_static_url": "xyz789",
        "secure_base_url": "xyz789",
        "share_active_segments": true,
        "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": 123,
        "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": 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": false,
        "zero_subtotal_enabled": true,
        "zero_subtotal_new_order_status": "abc123",
        "zero_subtotal_payment_action": "xyz789",
        "zero_subtotal_payment_from_specific_countries": "abc123",
        "zero_subtotal_sort_order": 123,
        "zero_subtotal_title": "abc123"
      }
    ]
  }
}

cart

Return information about the specified shopping cart.

Response: Cart

Arguments

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_gift_wrappings {
      ...GiftWrappingFragment
    }
    available_payment_methods {
      ...AvailablePaymentMethodFragment
    }
    billing_address {
      ...BillingCartAddressFragment
    }
    custom_attributes {
      ...CustomAttributeFragment
    }
    email
    gift_message {
      ...GiftMessageFragment
    }
    gift_receipt_included
    gift_wrapping {
      ...GiftWrappingFragment
    }
    id
    is_virtual
    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_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,
      "custom_attributes": [CustomAttribute],
      "email": "abc123",
      "gift_message": GiftMessage,
      "gift_receipt_included": false,
      "gift_wrapping": GiftWrapping,
      "id": 4,
      "is_virtual": true,
      "itemsV2": CartItems,
      "prices": CartPrices,
      "printed_card_included": false,
      "rules": [CartRuleStorefront],
      "selected_payment_method": SelectedPaymentMethod,
      "shipping_addresses": [ShippingCartAddress],
      "total_quantity": 987.65
    }
  }
}

categories

Deprecated

This field is deprecated and will be removed.

Return category views by IDs, with optional role filters and subtree scopes. In Adobe Commerce as a Cloud Service, this query replaces the categories query defined in the Commerce Foundation.

Response: [CategoryView]

Arguments

Example

Query

query categories(
  $ids: [String!],
  $roles: [String!],
  $subtree: Subtree
) {
  categories(
    ids: $ids,
    roles: $roles,
    subtree: $subtree
  ) {
    availableSortBy
    children
    defaultSortBy
    id
    level
    name
    parentId
    path
    roles
    urlKey
    urlPath
    count
    title
  }
}

Variables

{
  "ids": ["abc123"],
  "roles": ["abc123"],
  "subtree": Subtree
}

Response

{
  "data": {
    "categories": [
      {
        "availableSortBy": ["xyz789"],
        "children": ["xyz789"],
        "defaultSortBy": "abc123",
        "id": 4,
        "level": 123,
        "name": "abc123",
        "parentId": "abc123",
        "path": "abc123",
        "roles": ["abc123"],
        "urlKey": "abc123",
        "urlPath": "xyz789",
        "count": 987,
        "title": "abc123"
      }
    ]
  }
}

categoryTree

Retrieves category tree nodes, optionally filtered by family, slugs and limited by depth.

Response: [CategoryTreeView]

Arguments

Example

Query

query categoryTree(
  $family: String,
  $slugs: [String!],
  $depth: Int
) {
  categoryTree(
    family: $family,
    slugs: $slugs,
    depth: $depth
  ) {
    slug
    name
    description
    metaTags {
      ...CategoryMetaTagsFragment
    }
    images {
      ...CategoryImageFragment
    }
    level
    parentSlug
    childrenSlugs
  }
}

Variables

{
  "family": "xyz789",
  "slugs": ["xyz789"],
  "depth": 123
}

Response

{
  "data": {
    "categoryTree": [
      {
        "slug": "xyz789",
        "name": "xyz789",
        "description": "abc123",
        "metaTags": CategoryMetaTags,
        "images": [CategoryImage],
        "level": 123,
        "parentSlug": "xyz789",
        "childrenSlugs": ["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": 123,
        "checkbox_text": "xyz789",
        "content": "abc123",
        "content_height": "abc123",
        "is_html": false,
        "mode": "AUTO",
        "name": "xyz789"
      }
    ]
  }
}

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
    }
    available_payment_methods {
      ...AvailablePaymentMethodFragment
    }
    available_shipping_methods {
      ...CompanyAvailableShippingMethodFragment
    }
    company_admin {
      ...CustomerFragment
    }
    credit {
      ...CompanyCreditFragment
    }
    credit_history {
      ...CompanyCreditHistoryFragment
    }
    custom_attributes {
      ...CustomAttributeFragment
    }
    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],
      "available_payment_methods": [
        AvailablePaymentMethod
      ],
      "available_shipping_methods": [
        CompanyAvailableShippingMethod
      ],
      "company_admin": Customer,
      "credit": CompanyCredit,
      "credit_history": CompanyCreditHistory,
      "custom_attributes": [CustomAttribute],
      "email": "xyz789",
      "id": 4,
      "legal_address": CompanyLegalAddress,
      "legal_name": "abc123",
      "name": "abc123",
      "payment_methods": ["abc123"],
      "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

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

country

The countries query provides information for a single country.

Response: Country

Arguments

Example

Query

query country($id: String) {
  country(id: $id) {
    available_regions {
      ...RegionFragment
    }
    full_name_english
    full_name_locale
    id
    three_letter_abbreviation
    two_letter_abbreviation
  }
}

Variables

{"id": "abc123"}

Response

{
  "data": {
    "country": {
      "available_regions": [Region],
      "full_name_english": "abc123",
      "full_name_locale": "abc123",
      "id": "xyz789",
      "three_letter_abbreviation": "abc123",
      "two_letter_abbreviation": "abc123"
    }
  }
}

currency

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": "abc123",
      "default_display_currency_symbol": "xyz789",
      "exchange_rates": [ExchangeRate]
    }
  }
}

customAttributeMetadataV2

Retrieve EAV attributes metadata.

Response: AttributesMetadataOutput!

Arguments

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
    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,
      "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": "abc123",
      "default_shipping": "abc123",
      "email": "xyz789",
      "firstname": "xyz789",
      "gender": 987,
      "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": "abc123",
      "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_gift_wrappings {
      ...GiftWrappingFragment
    }
    available_payment_methods {
      ...AvailablePaymentMethodFragment
    }
    billing_address {
      ...BillingCartAddressFragment
    }
    custom_attributes {
      ...CustomAttributeFragment
    }
    email
    gift_message {
      ...GiftMessageFragment
    }
    gift_receipt_included
    gift_wrapping {
      ...GiftWrappingFragment
    }
    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_gift_wrappings": [GiftWrapping],
      "available_payment_methods": [
        AvailablePaymentMethod
      ],
      "billing_address": BillingCartAddress,
      "custom_attributes": [CustomAttribute],
      "email": "abc123",
      "gift_message": GiftMessage,
      "gift_receipt_included": false,
      "gift_wrapping": GiftWrapping,
      "id": "4",
      "is_virtual": false,
      "itemsV2": CartItems,
      "prices": CartPrices,
      "printed_card_included": true,
      "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}}}

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

Example

Query

query customerSegments($cartId: String!) {
  customerSegments(cartId: $cartId) {
    uid
  }
}

Variables

{"cartId": "abc123"}

Response

{"data": {"customerSegments": [{"uid": 4}]}}

getPaymentConfig

Retrieves the payment configuration for a given location

Response: PaymentConfigOutput

Arguments

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

Example

Query

query getPaymentOrder(
  $cartId: String!,
  $id: String!
) {
  getPaymentOrder(
    cartId: $cartId,
    id: $id
  ) {
    id
    mp_order_id
    payment_source_details {
      ...PaymentSourceDetailsFragment
    }
    status
  }
}

Variables

{
  "cartId": "xyz789",
  "id": "abc123"
}

Response

{
  "data": {
    "getPaymentOrder": {
      "id": "xyz789",
      "mp_order_id": "abc123",
      "payment_source_details": PaymentSourceDetails,
      "status": "abc123"
    }
  }
}

getPaymentSDK

Gets the payment SDK urls and values

Response: GetPaymentSDKOutput

Arguments

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

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

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": "xyz789",
      "items": [GiftRegistryItemInterface],
      "message": "abc123",
      "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

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

giftRegistryIdSearch

Search for gift registries by specifying a registry URL key.

Response: [GiftRegistrySearchResult]

Arguments

Example

Query

query giftRegistryIdSearch($giftRegistryUid: ID!) {
  giftRegistryIdSearch(giftRegistryUid: $giftRegistryUid) {
    event_date
    event_title
    gift_registry_uid
    location
    name
    type
  }
}

Variables

{"giftRegistryUid": 4}

Response

{
  "data": {
    "giftRegistryIdSearch": [
      {
        "event_date": "xyz789",
        "event_title": "xyz789",
        "gift_registry_uid": 4,
        "location": "abc123",
        "name": "xyz789",
        "type": "abc123"
      }
    ]
  }
}

giftRegistryTypeSearch

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

Response: [GiftRegistrySearchResult]

Arguments

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

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

Example

Query

query guestOrder($input: GuestOrderInformationInput!) {
  guestOrder(input: $input) {
    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": {
      "applied_coupons": [AppliedCoupon],
      "applied_gift_cards": [ApplyGiftCardToOrder],
      "available_actions": ["REORDER"],
      "billing_address": OrderAddress,
      "carrier": "xyz789",
      "comments": [SalesCommentItem],
      "credit_memos": [CreditMemo],
      "custom_attributes": [CustomAttribute],
      "customer_info": OrderCustomerInfo,
      "email": "abc123",
      "gift_message": GiftMessage,
      "gift_receipt_included": false,
      "gift_wrapping": GiftWrapping,
      "id": 4,
      "invoices": [Invoice],
      "is_virtual": true,
      "items": [OrderItemInterface],
      "items_eligible_for_return": [OrderItemInterface],
      "negotiable_quote": NegotiableQuote,
      "number": "xyz789",
      "order_date": "xyz789",
      "order_status_change_date": "abc123",
      "payment_methods": [OrderPaymentMethod],
      "printed_card_included": false,
      "returns": Returns,
      "shipments": [OrderShipment],
      "shipping_address": OrderAddress,
      "shipping_method": "xyz789",
      "status": "abc123",
      "token": "abc123",
      "total": OrderTotal
    }
  }
}

guestOrderByToken

Retrieve guest order details based on token.

Response: CustomerOrder!

Arguments

Example

Query

query guestOrderByToken($input: OrderTokenInput!) {
  guestOrderByToken(input: $input) {
    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": {
      "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": "xyz789",
      "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": "xyz789",
      "order_date": "abc123",
      "order_status_change_date": "xyz789",
      "payment_methods": [OrderPaymentMethod],
      "printed_card_included": false,
      "returns": Returns,
      "shipments": [OrderShipment],
      "shipping_address": OrderAddress,
      "shipping_method": "xyz789",
      "status": "abc123",
      "token": "abc123",
      "total": OrderTotal
    }
  }
}

isCompanyAdminEmailAvailable

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

Response: IsCompanyAdminEmailAvailableOutput

Arguments

Example

Query

query isCompanyAdminEmailAvailable($email: String!) {
  isCompanyAdminEmailAvailable(email: $email) {
    is_email_available
  }
}

Variables

{"email": "xyz789"}

Response

{"data": {"isCompanyAdminEmailAvailable": {"is_email_available": false}}}

isCompanyEmailAvailable

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

Response: IsCompanyEmailAvailableOutput

Arguments

Example

Query

query isCompanyEmailAvailable($email: String!) {
  isCompanyEmailAvailable(email: $email) {
    is_email_available
  }
}

Variables

{"email": "abc123"}

Response

{"data": {"isCompanyEmailAvailable": {"is_email_available": false}}}

isCompanyRoleNameAvailable

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

Response: IsCompanyRoleNameAvailableOutput

Arguments

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

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

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

Example

Query

query isSubscribedProductAlertPrice($input: ProductAlertPriceInput!) {
  isSubscribedProductAlertPrice(input: $input) {
    isSubscribed
    message
  }
}

Variables

{"input": ProductAlertPriceInput}

Response

{
  "data": {
    "isSubscribedProductAlertPrice": {
      "isSubscribed": false,
      "message": "xyz789"
    }
  }
}

isSubscribedProductAlertStock

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

Response: IsProductAlertSubscriptionResult!

Arguments

Example

Query

query isSubscribedProductAlertStock($input: ProductAlertStockInput!) {
  isSubscribedProductAlertStock(input: $input) {
    isSubscribed
    message
  }
}

Variables

{"input": ProductAlertStockInput}

Response

{
  "data": {
    "isSubscribedProductAlertStock": {
      "isSubscribed": false,
      "message": "abc123"
    }
  }
}

navigation

Retrieves the navigation tree for a given product family.

Response: [CategoryNavigationView]

Arguments

Example

Query

query navigation($family: String!) {
  navigation(family: $family) {
    slug
    name
    children {
      ...CategoryNavigationViewFragment
    }
  }
}

Variables

{"family": "xyz789"}

Response

{
  "data": {
    "navigation": [
      {
        "slug": "xyz789",
        "name": "xyz789",
        "children": [CategoryNavigationView]
      }
    ]
  }
}

negotiableQuote

Retrieve the specified negotiable quote.

Response: NegotiableQuote

Arguments

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": "xyz789",
      "custom_attributes": [CustomAttribute],
      "email": "abc123",
      "expiration_date": "abc123",
      "history": [NegotiableQuoteHistoryEntry],
      "is_virtual": true,
      "items": [CartItemInterface],
      "name": "xyz789",
      "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": 987.65,
      "uid": "4",
      "updated_at": "xyz789"
    }
  }
}

negotiableQuoteTemplate

Retrieve the specified negotiable quote template.

Response: NegotiableQuoteTemplate

Arguments

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": true,
      "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": "xyz789",
      "shipping_addresses": [
        NegotiableQuoteShippingAddress
      ],
      "status": "abc123",
      "template_id": "4",
      "total_quantity": 987.65,
      "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

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

Example

Query

query negotiableQuotes(
  $filter: NegotiableQuoteFilterInput,
  $pageSize: Int,
  $currentPage: Int,
  $sort: NegotiableQuoteSortInput
) {
  negotiableQuotes(
    filter: $filter,
    pageSize: $pageSize,
    currentPage: $currentPage,
    sort: $sort
  ) {
    items {
      ...NegotiableQuoteFragment
    }
    page_info {
      ...SearchResultPageInfoFragment
    }
    sort_fields {
      ...SortFieldsFragment
    }
    total_count
  }
}

Variables

{
  "filter": NegotiableQuoteFilterInput,
  "pageSize": 20,
  "currentPage": 1,
  "sort": NegotiableQuoteSortInput
}

Response

{
  "data": {
    "negotiableQuotes": {
      "items": [NegotiableQuote],
      "page_info": SearchResultPageInfo,
      "sort_fields": SortFields,
      "total_count": 987
    }
  }
}

pickupLocations

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

Response: PickupLocations

Arguments

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

productSearch

Search products using Live Search

Response: ProductSearchResponse!

Arguments

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": "abc123",
  "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. In Adobe Commerce as a Cloud Service, this query replaces the products query defined in the Commerce Foundation.

Response: [ProductView]

Arguments

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
    url
    urlKey
    links {
      ...ProductViewLinkFragment
    }
    categories {
      ...CategoryProductViewFragment
    }
    queryType
    visibility
  }
}

Variables

{"skus": ["abc123"]}

Response

{
  "data": {
    "products": [
      {
        "addToCartAllowed": true,
        "inStock": false,
        "lowStock": true,
        "attributes": [ProductViewAttribute],
        "description": "xyz789",
        "id": 4,
        "images": [ProductViewImage],
        "videos": [ProductViewVideo],
        "lastModifiedAt": "2007-12-03T10:15:30Z",
        "metaDescription": "xyz789",
        "metaKeyword": "xyz789",
        "metaTitle": "xyz789",
        "name": "abc123",
        "shortDescription": "abc123",
        "inputOptions": [ProductViewInputOption],
        "sku": "abc123",
        "externalId": "abc123",
        "url": "xyz789",
        "urlKey": "xyz789",
        "links": [ProductViewLink],
        "categories": [CategoryProductView],
        "queryType": "xyz789",
        "visibility": "xyz789"
      }
    ]
  }
}

recaptchaFormConfig

Response: ReCaptchaConfigOutput

Arguments

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

recaptchaFormConfigs

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

Response: [ReCaptchaFormConfigItem]

Arguments

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

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": "abc123",
      "forms": ["PLACE_ORDER"],
      "is_enabled": true,
      "language_code": "xyz789",
      "minimum_score": 987.65,
      "theme": "abc123",
      "website_key": "abc123"
    }
  }
}

recommendations

Get Recommendations

Response: Recommendations

Arguments

Example

Query

query recommendations(
  $cartSkus: [String],
  $category: String,
  $currentSku: String,
  $pageType: PageType,
  $userPurchaseHistory: [PurchaseHistory],
  $userViewHistory: [ViewHistory],
  $config: UnitConfigInput
) {
  recommendations(
    cartSkus: $cartSkus,
    category: $category,
    currentSku: $currentSku,
    pageType: $pageType,
    userPurchaseHistory: $userPurchaseHistory,
    userViewHistory: $userViewHistory,
    config: $config
  ) {
    results {
      ...RecommendationUnitFragment
    }
    totalResults
  }
}

Variables

{
  "cartSkus": ["abc123"],
  "category": "abc123",
  "currentSku": "abc123",
  "pageType": "CMS",
  "userPurchaseHistory": [PurchaseHistory],
  "userViewHistory": [ViewHistory],
  "config": UnitConfigInput
}

Response

{
  "data": {
    "recommendations": {
      "results": [RecommendationUnit],
      "totalResults": 123
    }
  }
}

recommendationsByUnitIds

Response: Recommendations

Arguments

Example

Query

query recommendationsByUnitIds(
  $unitIds: [String!]!,
  $currentSku: String,
  $userPurchaseHistory: [PurchaseHistory],
  $userViewHistory: [ViewHistory],
  $cartSkus: [String]
) {
  recommendationsByUnitIds(
    unitIds: $unitIds,
    currentSku: $currentSku,
    userPurchaseHistory: $userPurchaseHistory,
    userViewHistory: $userViewHistory,
    cartSkus: $cartSkus
  ) {
    results {
      ...RecommendationUnitFragment
    }
    totalResults
  }
}

Variables

{
  "unitIds": ["abc123"],
  "currentSku": "abc123",
  "userPurchaseHistory": [PurchaseHistory],
  "userViewHistory": [ViewHistory],
  "cartSkus": ["abc123"]
}

Response

{
  "data": {
    "recommendationsByUnitIds": {
      "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

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
    url
    urlKey
    links {
      ...ProductViewLinkFragment
    }
    categories {
      ...CategoryProductViewFragment
    }
    queryType
    visibility
  }
}

Variables

{
  "optionIds": ["xyz789"],
  "sku": "xyz789"
}

Response

{
  "data": {
    "refineProduct": {
      "addToCartAllowed": false,
      "inStock": false,
      "lowStock": false,
      "attributes": [ProductViewAttribute],
      "description": "xyz789",
      "id": 4,
      "images": [ProductViewImage],
      "videos": [ProductViewVideo],
      "lastModifiedAt": "2007-12-03T10:15:30Z",
      "metaDescription": "abc123",
      "metaKeyword": "xyz789",
      "metaTitle": "xyz789",
      "name": "xyz789",
      "shortDescription": "abc123",
      "inputOptions": [ProductViewInputOption],
      "sku": "abc123",
      "externalId": "abc123",
      "url": "xyz789",
      "urlKey": "xyz789",
      "links": [ProductViewLink],
      "categories": [CategoryProductView],
      "queryType": "xyz789",
      "visibility": "abc123"
    }
  }
}

searchCategory

Search for categories by name with optional filtering and pagination.

Response: SearchCategoryResultPage

Arguments

Example

Query

query searchCategory(
  $searchTerm: String!,
  $family: String,
  $pageSize: Int,
  $currentPage: Int
) {
  searchCategory(
    searchTerm: $searchTerm,
    family: $family,
    pageSize: $pageSize,
    currentPage: $currentPage
  ) {
    items {
      ...CategoryTreeViewFragment
    }
    totalCount
    pageInfo {
      ...PageInfoFragment
    }
  }
}

Variables

{
  "searchTerm": "abc123",
  "family": "xyz789",
  "pageSize": 20,
  "currentPage": 1
}

Response

{
  "data": {
    "searchCategory": {
      "items": [CategoryTreeView],
      "totalCount": 123,
      "pageInfo": PageInfo
    }
  }
}

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
    printed_card_priceV2 {
      ...MoneyFragment
    }
    product_fixed_product_tax_display_setting
    product_url_suffix
    quickorder_active
    quote_minimum_amount
    quote_minimum_amount_message
    required_character_classes_number
    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
    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": true,
      "allow_gift_receipt": "xyz789",
      "allow_gift_wrapping_on_order": "xyz789",
      "allow_gift_wrapping_on_order_items": "abc123",
      "allow_items": "xyz789",
      "allow_order": "xyz789",
      "allow_printed_card": "xyz789",
      "autocomplete_on_storefront": true,
      "base_currency_code": "xyz789",
      "base_link_url": "xyz789",
      "base_media_url": "abc123",
      "base_static_url": "abc123",
      "base_url": "xyz789",
      "cart_expires_in_days": 123,
      "cart_gift_wrapping": "xyz789",
      "cart_merge_preference": "abc123",
      "cart_printed_card": "abc123",
      "cart_summary_display_quantity": 987,
      "catalog_default_sort_by": "xyz789",
      "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
      "category_url_suffix": "xyz789",
      "check_money_order_enable_for_specific_countries": true,
      "check_money_order_enabled": false,
      "check_money_order_make_check_payable_to": "abc123",
      "check_money_order_max_order_total": "abc123",
      "check_money_order_min_order_total": "abc123",
      "check_money_order_new_order_status": "abc123",
      "check_money_order_payment_from_specific_countries": "xyz789",
      "check_money_order_send_check_to": "xyz789",
      "check_money_order_sort_order": 123,
      "check_money_order_title": "xyz789",
      "company_credit_enabled": true,
      "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": 987.65,
      "default_country": "abc123",
      "default_display_currency_code": "abc123",
      "display_product_prices_in_catalog": 987,
      "display_shipping_prices": 987,
      "display_state_if_optional": false,
      "enable_multiple_wishlists": "xyz789",
      "fixed_product_taxes_apply_tax_to_fpt": true,
      "fixed_product_taxes_display_prices_in_emails": 123,
      "fixed_product_taxes_display_prices_in_product_lists": 987,
      "fixed_product_taxes_display_prices_in_sales_modules": 123,
      "fixed_product_taxes_display_prices_on_product_view_page": 987,
      "fixed_product_taxes_enable": false,
      "fixed_product_taxes_include_fpt_in_subtotal": false,
      "graphql_share_customer_group": true,
      "grid_per_page": 123,
      "grid_per_page_values": "abc123",
      "grouped_product_image": "ITSELF",
      "is_checkout_agreements_enabled": true,
      "is_default_store": true,
      "is_default_store_group": false,
      "is_guest_checkout_enabled": true,
      "is_negotiable_quote_active": true,
      "is_one_page_checkout_enabled": true,
      "is_requisition_list_active": "abc123",
      "list_mode": "xyz789",
      "list_per_page": 123,
      "list_per_page_values": "xyz789",
      "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": "xyz789",
      "magento_reward_points_invitation_customer": "xyz789",
      "magento_reward_points_invitation_customer_limit": "xyz789",
      "magento_reward_points_invitation_order": "abc123",
      "magento_reward_points_invitation_order_limit": "xyz789",
      "magento_reward_points_newsletter": "abc123",
      "magento_reward_points_order": "abc123",
      "magento_reward_points_register": "xyz789",
      "magento_reward_points_review": "abc123",
      "magento_reward_points_review_limit": "abc123",
      "magento_wishlist_general_is_enabled": "xyz789",
      "max_items_in_order_summary": 123,
      "maximum_number_of_wishlists": "xyz789",
      "minicart_display": false,
      "minicart_max_items": 987,
      "minimum_password_length": "xyz789",
      "newsletter_enabled": true,
      "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": false,
      "orders_invoices_credit_memos_display_price": 987,
      "orders_invoices_credit_memos_display_shipping_amount": 123,
      "orders_invoices_credit_memos_display_subtotal": 123,
      "orders_invoices_credit_memos_display_zero_tax": false,
      "printed_card_priceV2": Money,
      "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": "xyz789",
      "required_character_classes_number": "xyz789",
      "returns_enabled": "abc123",
      "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": "xyz789",
      "secure_base_media_url": "xyz789",
      "secure_base_static_url": "abc123",
      "secure_base_url": "xyz789",
      "share_active_segments": false,
      "share_applied_cart_rule": 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": 987,
      "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": "xyz789",
      "title_separator": "xyz789",
      "use_store_in_url": true,
      "website_code": 4,
      "website_name": "abc123",
      "weight_unit": "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": "xyz789",
      "zero_subtotal_sort_order": 123,
      "zero_subtotal_title": "xyz789"
    }
  }
}

variants

Response: ProductViewVariantResults

Arguments

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": "abc123",
  "optionIds": ["xyz789"],
  "pageSize": 123,
  "cursor": "abc123"
}

Response

{
  "data": {
    "variants": {
      "variants": [ProductViewVariant],
      "cursor": "abc123"
    }
  }
}