Edit in GitHubLog an issue
PaaS only

GraphQL API reference (2.4.9)

The Adobe Commerce GraphQL API allows you to quickly and efficiently transfer information between your Commerce store and your storefront. The schema documented here is autogenerated from an instance of Adobe Commerce with B2B. You can find examples of each query and mutation in the main GraphQL documentation.

API endpoint

Copied to your clipboard
https://<your store>/graphql

Headers

Copied to your clipboard
# For header information, refer to <a href="https://developer.adobe.com/commerce/webapi/graphql/usage/headers">GraphQL headers</a>.
Authorization: Bearer <YOUR_TOKEN_HERE>

Required headers

All API requests must include the following headers:

Queries

attributesForm

Retrieve EAV attributes associated to a frontend form. Use countries query provided by DirectoryGraphQl module to retrieve region_id and country_id attribute options.

Response: AttributesFormOutput!

Arguments

NameDescription
formCode - String!
Form code.

Example

Query
Copied to your clipboard
query attributesForm($formCode: String!) {
  attributesForm(formCode: $formCode) {
    errors {
      ...AttributeMetadataErrorFragment
    }
    items {
      ...CustomAttributeMetadataInterfaceFragment
    }
  }
}
Variables
Copied to your clipboard
{"formCode": "abc123"}
Response
Copied to your clipboard
{
  "data": {
    "attributesForm": {
      "errors": [AttributeMetadataError],
      "items": [CustomAttributeMetadataInterface]
    }
  }
}

attributesList

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

Response: AttributesMetadataOutput

Arguments

NameDescription
entityType - AttributeEntityTypeEnum!
Entity type.
filters - AttributeFilterInput
Identifies which filter inputs to search for and return.

Example

Query
Copied to your clipboard
query attributesList(
  $entityType: AttributeEntityTypeEnum!,
  $filters: AttributeFilterInput
) {
  attributesList(
    entityType: $entityType,
    filters: $filters
  ) {
    errors {
      ...AttributeMetadataErrorFragment
    }
    items {
      ...CustomAttributeMetadataInterfaceFragment
    }
  }
}
Variables
Copied to your clipboard
{
  "entityType": "CATALOG_PRODUCT",
  "filters": AttributeFilterInput
}
Response
Copied to your clipboard
{
  "data": {
    "attributesList": {
      "errors": [AttributeMetadataError],
      "items": [CustomAttributeMetadataInterface]
    }
  }
}

availableStores

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

Response: [StoreConfig]

Arguments

NameDescription
useCurrentGroup - Boolean
Filter store views by the current store group.

Example

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

cart

Return information about the specified shopping cart.

Response: Cart

Arguments

NameDescription
cart_id - String!
The unique ID of the cart to query.

Example

Query
Copied to your clipboard
query cart($cart_id: String!) {
  cart(cart_id: $cart_id) {
    applied_coupon {
      ...AppliedCouponFragment
    }
    applied_coupons {
      ...AppliedCouponFragment
    }
    applied_gift_cards {
      ...AppliedGiftCardFragment
    }
    applied_reward_points {
      ...RewardPointsAmountFragment
    }
    applied_store_credit {
      ...AppliedStoreCreditFragment
    }
    available_gift_wrappings {
      ...GiftWrappingFragment
    }
    available_payment_methods {
      ...AvailablePaymentMethodFragment
    }
    billing_address {
      ...BillingCartAddressFragment
    }
    email
    gift_message {
      ...GiftMessageFragment
    }
    gift_receipt_included
    gift_wrapping {
      ...GiftWrappingFragment
    }
    id
    is_virtual
    items {
      ...CartItemInterfaceFragment
    }
    itemsV2 {
      ...CartItemsFragment
    }
    prices {
      ...CartPricesFragment
    }
    printed_card_included
    rules {
      ...CartRuleStorefrontFragment
    }
    selected_payment_method {
      ...SelectedPaymentMethodFragment
    }
    shipping_addresses {
      ...ShippingCartAddressFragment
    }
    total_quantity
  }
}
Variables
Copied to your clipboard
{"cart_id": "xyz789"}
Response
Copied to your clipboard
{
  "data": {
    "cart": {
      "applied_coupon": AppliedCoupon,
      "applied_coupons": [AppliedCoupon],
      "applied_gift_cards": [AppliedGiftCard],
      "applied_reward_points": RewardPointsAmount,
      "applied_store_credit": AppliedStoreCredit,
      "available_gift_wrappings": [GiftWrapping],
      "available_payment_methods": [
        AvailablePaymentMethod
      ],
      "billing_address": BillingCartAddress,
      "email": "abc123",
      "gift_message": GiftMessage,
      "gift_receipt_included": false,
      "gift_wrapping": GiftWrapping,
      "id": "4",
      "is_virtual": true,
      "items": [CartItemInterface],
      "itemsV2": CartItems,
      "prices": CartPrices,
      "printed_card_included": false,
      "rules": [CartRuleStorefront],
      "selected_payment_method": SelectedPaymentMethod,
      "shipping_addresses": [ShippingCartAddress],
      "total_quantity": 987.65
    }
  }
}

categories

Return a list of categories that match the specified filter.

Response: CategoryResult

Arguments

NameDescription
filters - CategoryFilterInput
Identifies which Category filter inputs to search for and return.
pageSize - Int
Specifies the maximum number of results to return at once. The default value is 20. Default: 20
currentPage - Int
Specifies which page of results to return. The default value is 1. Default: 1

Example

Query
Copied to your clipboard
query categories(
  $filters: CategoryFilterInput,
  $pageSize: Int,
  $currentPage: Int
) {
  categories(
    filters: $filters,
    pageSize: $pageSize,
    currentPage: $currentPage
  ) {
    items {
      ...CategoryTreeFragment
    }
    page_info {
      ...SearchResultPageInfoFragment
    }
    total_count
  }
}
Variables
Copied to your clipboard
{
  "filters": CategoryFilterInput,
  "pageSize": 20,
  "currentPage": 1
}
Response
Copied to your clipboard
{
  "data": {
    "categories": {
      "items": [CategoryTree],
      "page_info": SearchResultPageInfo,
      "total_count": 987
    }
  }
}

category

Deprecated

Use categories instead.

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

Response: CategoryTree

Arguments

NameDescription
id - Int
The category ID to use as the root of the search.

Example

Query
Copied to your clipboard
query category($id: Int) {
  category(id: $id) {
    automatic_sorting
    available_sort_by
    breadcrumbs {
      ...BreadcrumbFragment
    }
    canonical_url
    children {
      ...CategoryTreeFragment
    }
    children_count
    cms_block {
      ...CmsBlockFragment
    }
    created_at
    custom_layout_update_file
    default_sort_by
    description
    display_mode
    filter_price_range
    id
    image
    include_in_menu
    is_anchor
    landing_page
    level
    meta_description
    meta_keywords
    meta_title
    name
    path
    path_in_store
    position
    product_count
    products {
      ...CategoryProductsFragment
    }
    redirect_code
    relative_url
    staged
    type
    uid
    updated_at
    url_key
    url_path
    url_suffix
  }
}
Variables
Copied to your clipboard
{"id": 987}
Response
Copied to your clipboard
{
  "data": {
    "category": {
      "automatic_sorting": "xyz789",
      "available_sort_by": ["abc123"],
      "breadcrumbs": [Breadcrumb],
      "canonical_url": "xyz789",
      "children": [CategoryTree],
      "children_count": "abc123",
      "cms_block": CmsBlock,
      "created_at": "xyz789",
      "custom_layout_update_file": "xyz789",
      "default_sort_by": "abc123",
      "description": "abc123",
      "display_mode": "xyz789",
      "filter_price_range": 123.45,
      "id": 987,
      "image": "abc123",
      "include_in_menu": 123,
      "is_anchor": 987,
      "landing_page": 123,
      "level": 123,
      "meta_description": "abc123",
      "meta_keywords": "abc123",
      "meta_title": "abc123",
      "name": "xyz789",
      "path": "abc123",
      "path_in_store": "xyz789",
      "position": 123,
      "product_count": 987,
      "products": CategoryProducts,
      "redirect_code": 123,
      "relative_url": "abc123",
      "staged": true,
      "type": "CMS_PAGE",
      "uid": "4",
      "updated_at": "xyz789",
      "url_key": "abc123",
      "url_path": "xyz789",
      "url_suffix": "abc123"
    }
  }
}

categoryList

Deprecated

Use categories instead.

Return an array of categories based on the specified filters.

Response: [CategoryTree]

Arguments

NameDescription
filters - CategoryFilterInput
Identifies which Category filter inputs to search for and return.
pageSize - Int
Specifies the maximum number of results to return at once. The default value is 20. Default: 20
currentPage - Int
Specifies which page of results to return. The default value is 1. Default: 1

Example

Query
Copied to your clipboard
query categoryList(
  $filters: CategoryFilterInput,
  $pageSize: Int,
  $currentPage: Int
) {
  categoryList(
    filters: $filters,
    pageSize: $pageSize,
    currentPage: $currentPage
  ) {
    automatic_sorting
    available_sort_by
    breadcrumbs {
      ...BreadcrumbFragment
    }
    canonical_url
    children {
      ...CategoryTreeFragment
    }
    children_count
    cms_block {
      ...CmsBlockFragment
    }
    created_at
    custom_layout_update_file
    default_sort_by
    description
    display_mode
    filter_price_range
    id
    image
    include_in_menu
    is_anchor
    landing_page
    level
    meta_description
    meta_keywords
    meta_title
    name
    path
    path_in_store
    position
    product_count
    products {
      ...CategoryProductsFragment
    }
    redirect_code
    relative_url
    staged
    type
    uid
    updated_at
    url_key
    url_path
    url_suffix
  }
}
Variables
Copied to your clipboard
{
  "filters": CategoryFilterInput,
  "pageSize": 20,
  "currentPage": 1
}
Response
Copied to your clipboard
{
  "data": {
    "categoryList": [
      {
        "automatic_sorting": "abc123",
        "available_sort_by": ["abc123"],
        "breadcrumbs": [Breadcrumb],
        "canonical_url": "xyz789",
        "children": [CategoryTree],
        "children_count": "xyz789",
        "cms_block": CmsBlock,
        "created_at": "abc123",
        "custom_layout_update_file": "xyz789",
        "default_sort_by": "abc123",
        "description": "xyz789",
        "display_mode": "abc123",
        "filter_price_range": 123.45,
        "id": 123,
        "image": "xyz789",
        "include_in_menu": 987,
        "is_anchor": 987,
        "landing_page": 123,
        "level": 987,
        "meta_description": "abc123",
        "meta_keywords": "xyz789",
        "meta_title": "abc123",
        "name": "abc123",
        "path": "xyz789",
        "path_in_store": "xyz789",
        "position": 123,
        "product_count": 987,
        "products": CategoryProducts,
        "redirect_code": 123,
        "relative_url": "xyz789",
        "staged": false,
        "type": "CMS_PAGE",
        "uid": "4",
        "updated_at": "xyz789",
        "url_key": "xyz789",
        "url_path": "xyz789",
        "url_suffix": "xyz789"
      }
    ]
  }
}

checkoutAgreements

Return Terms and Conditions configuration information.

Response: [CheckoutAgreement]

Example

Query
Copied to your clipboard
query checkoutAgreements {
  checkoutAgreements {
    agreement_id
    checkbox_text
    content
    content_height
    is_html
    mode
    name
  }
}
Response
Copied to your clipboard
{
  "data": {
    "checkoutAgreements": [
      {
        "agreement_id": 987,
        "checkbox_text": "xyz789",
        "content": "abc123",
        "content_height": "abc123",
        "is_html": false,
        "mode": "AUTO",
        "name": "xyz789"
      }
    ]
  }
}

cmsBlocks

Return information about CMS blocks.

Response: CmsBlocks

Arguments

NameDescription
identifiers - [String]
An array of CMS block IDs.

Example

Query
Copied to your clipboard
query cmsBlocks($identifiers: [String]) {
  cmsBlocks(identifiers: $identifiers) {
    items {
      ...CmsBlockFragment
    }
  }
}
Variables
Copied to your clipboard
{"identifiers": ["abc123"]}
Response
Copied to your clipboard
{"data": {"cmsBlocks": {"items": [CmsBlock]}}}

cmsPage

Return details about a CMS page.

Response: CmsPage

Arguments

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

Example

Query
Copied to your clipboard
query cmsPage(
  $id: Int,
  $identifier: String
) {
  cmsPage(
    id: $id,
    identifier: $identifier
  ) {
    content
    content_heading
    identifier
    meta_description
    meta_keywords
    meta_title
    page_layout
    redirect_code
    relative_url
    title
    type
    url_key
  }
}
Variables
Copied to your clipboard
{"id": 123, "identifier": "abc123"}
Response
Copied to your clipboard
{
  "data": {
    "cmsPage": {
      "content": "abc123",
      "content_heading": "xyz789",
      "identifier": "abc123",
      "meta_description": "xyz789",
      "meta_keywords": "abc123",
      "meta_title": "xyz789",
      "page_layout": "abc123",
      "redirect_code": 987,
      "relative_url": "abc123",
      "title": "abc123",
      "type": "CMS_PAGE",
      "url_key": "xyz789"
    }
  }
}

company

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

Response: Company

Example

Query
Copied to your clipboard
query company {
  company {
    acl_resources {
      ...CompanyAclResourceFragment
    }
    company_admin {
      ...CustomerFragment
    }
    credit {
      ...CompanyCreditFragment
    }
    credit_history {
      ...CompanyCreditHistoryFragment
    }
    email
    id
    legal_address {
      ...CompanyLegalAddressFragment
    }
    legal_name
    name
    payment_methods
    reseller_id
    role {
      ...CompanyRoleFragment
    }
    roles {
      ...CompanyRolesFragment
    }
    sales_representative {
      ...CompanySalesRepresentativeFragment
    }
    structure {
      ...CompanyStructureFragment
    }
    team {
      ...CompanyTeamFragment
    }
    user {
      ...CustomerFragment
    }
    users {
      ...CompanyUsersFragment
    }
    vat_tax_id
  }
}
Response
Copied to your clipboard
{
  "data": {
    "company": {
      "acl_resources": [CompanyAclResource],
      "company_admin": Customer,
      "credit": CompanyCredit,
      "credit_history": CompanyCreditHistory,
      "email": "abc123",
      "id": 4,
      "legal_address": CompanyLegalAddress,
      "legal_name": "abc123",
      "name": "xyz789",
      "payment_methods": ["abc123"],
      "reseller_id": "xyz789",
      "role": CompanyRole,
      "roles": CompanyRoles,
      "sales_representative": CompanySalesRepresentative,
      "structure": CompanyStructure,
      "team": CompanyTeam,
      "user": Customer,
      "users": CompanyUsers,
      "vat_tax_id": "xyz789"
    }
  }
}

compareList

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

Response: CompareList

Arguments

NameDescription
uid - ID!
The unique ID of the compare list to be queried.

Example

Query
Copied to your clipboard
query compareList($uid: ID!) {
  compareList(uid: $uid) {
    attributes {
      ...ComparableAttributeFragment
    }
    item_count
    items {
      ...ComparableItemFragment
    }
    uid
  }
}
Variables
Copied to your clipboard
{"uid": 4}
Response
Copied to your clipboard
{
  "data": {
    "compareList": {
      "attributes": [ComparableAttribute],
      "item_count": 123,
      "items": [ComparableItem],
      "uid": 4
    }
  }
}

countries

The countries query provides information for all countries.

Response: [Country]

Example

Query
Copied to your clipboard
query countries {
  countries {
    available_regions {
      ...RegionFragment
    }
    full_name_english
    full_name_locale
    id
    three_letter_abbreviation
    two_letter_abbreviation
  }
}
Response
Copied to your clipboard
{
  "data": {
    "countries": [
      {
        "available_regions": [Region],
        "full_name_english": "xyz789",
        "full_name_locale": "xyz789",
        "id": "abc123",
        "three_letter_abbreviation": "xyz789",
        "two_letter_abbreviation": "xyz789"
      }
    ]
  }
}

country

The countries query provides information for a single country.

Response: Country

Arguments

NameDescription
id - String

Example

Query
Copied to your clipboard
query country($id: String) {
  country(id: $id) {
    available_regions {
      ...RegionFragment
    }
    full_name_english
    full_name_locale
    id
    three_letter_abbreviation
    two_letter_abbreviation
  }
}
Variables
Copied to your clipboard
{"id": "xyz789"}
Response
Copied to your clipboard
{
  "data": {
    "country": {
      "available_regions": [Region],
      "full_name_english": "xyz789",
      "full_name_locale": "xyz789",
      "id": "xyz789",
      "three_letter_abbreviation": "abc123",
      "two_letter_abbreviation": "xyz789"
    }
  }
}

currency

Return information about the store's currency.

Response: Currency

Example

Query
Copied to your clipboard
query currency {
  currency {
    available_currency_codes
    base_currency_code
    base_currency_symbol
    default_display_currecy_code
    default_display_currecy_symbol
    default_display_currency_code
    default_display_currency_symbol
    exchange_rates {
      ...ExchangeRateFragment
    }
  }
}
Response
Copied to your clipboard
{
  "data": {
    "currency": {
      "available_currency_codes": [
        "xyz789"
      ],
      "base_currency_code": "xyz789",
      "base_currency_symbol": "abc123",
      "default_display_currecy_code": "xyz789",
      "default_display_currecy_symbol": "xyz789",
      "default_display_currency_code": "xyz789",
      "default_display_currency_symbol": "xyz789",
      "exchange_rates": [ExchangeRate]
    }
  }
}

customAttributeMetadata

Deprecated

Use customAttributeMetadataV2 query instead.

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

Response: CustomAttributeMetadata

Arguments

NameDescription
attributes - [AttributeInput!]!
An input object that specifies the attribute code and entity type to search.

Example

Query
Copied to your clipboard
query customAttributeMetadata($attributes: [AttributeInput!]!) {
  customAttributeMetadata(attributes: $attributes) {
    items {
      ...AttributeFragment
    }
  }
}
Variables
Copied to your clipboard
{"attributes": [AttributeInput]}
Response
Copied to your clipboard
{
  "data": {
    "customAttributeMetadata": {"items": [Attribute]}
  }
}

customAttributeMetadataV2

Retrieve EAV attributes metadata.

Response: AttributesMetadataOutput!

Arguments

NameDescription
attributes - [AttributeInput!]

Example

Query
Copied to your clipboard
query customAttributeMetadataV2($attributes: [AttributeInput!]) {
  customAttributeMetadataV2(attributes: $attributes) {
    errors {
      ...AttributeMetadataErrorFragment
    }
    items {
      ...CustomAttributeMetadataInterfaceFragment
    }
  }
}
Variables
Copied to your clipboard
{"attributes": [AttributeInput]}
Response
Copied to your clipboard
{
  "data": {
    "customAttributeMetadataV2": {
      "errors": [AttributeMetadataError],
      "items": [CustomAttributeMetadataInterface]
    }
  }
}

customer

Return detailed information about a customer account.

Response: Customer

Example

Query
Copied to your clipboard
query customer {
  customer {
    addresses {
      ...CustomerAddressFragment
    }
    addressesV2 {
      ...CustomerAddressesFragment
    }
    allow_remote_shopping_assistance
    companies {
      ...UserCompaniesOutputFragment
    }
    compare_list {
      ...CompareListFragment
    }
    confirmation_status
    created_at
    custom_attributes {
      ...AttributeValueInterfaceFragment
    }
    date_of_birth
    default_billing
    default_shipping
    dob
    email
    firstname
    gender
    gift_registries {
      ...GiftRegistryFragment
    }
    gift_registry {
      ...GiftRegistryFragment
    }
    group {
      ...CustomerGroupStorefrontFragment
    }
    group_id
    id
    is_subscribed
    job_title
    lastname
    middlename
    orders {
      ...CustomerOrdersFragment
    }
    prefix
    purchase_order {
      ...PurchaseOrderFragment
    }
    purchase_order_approval_rule {
      ...PurchaseOrderApprovalRuleFragment
    }
    purchase_order_approval_rule_metadata {
      ...PurchaseOrderApprovalRuleMetadataFragment
    }
    purchase_order_approval_rules {
      ...PurchaseOrderApprovalRulesFragment
    }
    purchase_orders {
      ...PurchaseOrdersFragment
    }
    purchase_orders_enabled
    requisition_lists {
      ...RequisitionListsFragment
    }
    return {
      ...ReturnFragment
    }
    returns {
      ...ReturnsFragment
    }
    reviews {
      ...ProductReviewsFragment
    }
    reward_points {
      ...RewardPointsFragment
    }
    role {
      ...CompanyRoleFragment
    }
    segments {
      ...CustomerSegmentStorefrontFragment
    }
    status
    store_credit {
      ...CustomerStoreCreditFragment
    }
    structure_id
    suffix
    taxvat
    team {
      ...CompanyTeamFragment
    }
    telephone
    wishlist {
      ...WishlistFragment
    }
    wishlist_v2 {
      ...WishlistFragment
    }
    wishlists {
      ...WishlistFragment
    }
  }
}
Response
Copied to your clipboard
{
  "data": {
    "customer": {
      "addresses": [CustomerAddress],
      "addressesV2": CustomerAddresses,
      "allow_remote_shopping_assistance": false,
      "companies": UserCompaniesOutput,
      "compare_list": CompareList,
      "confirmation_status": "ACCOUNT_CONFIRMED",
      "created_at": "xyz789",
      "custom_attributes": [AttributeValueInterface],
      "date_of_birth": "abc123",
      "default_billing": "abc123",
      "default_shipping": "abc123",
      "dob": "xyz789",
      "email": "xyz789",
      "firstname": "abc123",
      "gender": 987,
      "gift_registries": [GiftRegistry],
      "gift_registry": GiftRegistry,
      "group": CustomerGroupStorefront,
      "group_id": 123,
      "id": "4",
      "is_subscribed": false,
      "job_title": "xyz789",
      "lastname": "abc123",
      "middlename": "abc123",
      "orders": CustomerOrders,
      "prefix": "xyz789",
      "purchase_order": PurchaseOrder,
      "purchase_order_approval_rule": PurchaseOrderApprovalRule,
      "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata,
      "purchase_order_approval_rules": PurchaseOrderApprovalRules,
      "purchase_orders": PurchaseOrders,
      "purchase_orders_enabled": true,
      "requisition_lists": RequisitionLists,
      "return": Return,
      "returns": Returns,
      "reviews": ProductReviews,
      "reward_points": RewardPoints,
      "role": CompanyRole,
      "segments": [CustomerSegmentStorefront],
      "status": "ACTIVE",
      "store_credit": CustomerStoreCredit,
      "structure_id": "4",
      "suffix": "abc123",
      "taxvat": "xyz789",
      "team": CompanyTeam,
      "telephone": "xyz789",
      "wishlist": Wishlist,
      "wishlist_v2": Wishlist,
      "wishlists": [Wishlist]
    }
  }
}

customerCart

Return information about the customer's shopping cart.

Response: Cart!

Example

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

customerDownloadableProducts

Return a list of downloadable products the customer has purchased.

Response: CustomerDownloadableProducts

Example

Query
Copied to your clipboard
query customerDownloadableProducts {
  customerDownloadableProducts {
    items {
      ...CustomerDownloadableProductFragment
    }
  }
}
Response
Copied to your clipboard
{
  "data": {
    "customerDownloadableProducts": {
      "items": [CustomerDownloadableProduct]
    }
  }
}

customerGroup

Provides Customer Group assigned to the Customer or Guest.

Response: CustomerGroupStorefront!

Example

Query
Copied to your clipboard
query customerGroup {
  customerGroup {
    uid
  }
}
Response
Copied to your clipboard
{"data": {"customerGroup": {"uid": 4}}}

customerOrders

Deprecated

Use the customer query instead.

Response: CustomerOrders

Example

Query
Copied to your clipboard
query customerOrders {
  customerOrders {
    date_of_first_order
    items {
      ...CustomerOrderFragment
    }
    page_info {
      ...SearchResultPageInfoFragment
    }
    total_count
  }
}
Response
Copied to your clipboard
{
  "data": {
    "customerOrders": {
      "date_of_first_order": "abc123",
      "items": [CustomerOrder],
      "page_info": SearchResultPageInfo,
      "total_count": 123
    }
  }
}

customerPaymentTokens

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

Response: CustomerPaymentTokens

Example

Query
Copied to your clipboard
query customerPaymentTokens {
  customerPaymentTokens {
    items {
      ...PaymentTokenFragment
    }
  }
}
Response
Copied to your clipboard
{
  "data": {
    "customerPaymentTokens": {"items": [PaymentToken]}
  }
}

customerSegments

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

Response: [CustomerSegmentStorefront]

Arguments

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

Example

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

dynamicBlocks

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

Response: DynamicBlocks!

Arguments

NameDescription
input - DynamicBlocksFilterInput
Defines the filter for returning matching dynamic blocks.
pageSize - Int
The maximum number of results to return at once. The default is 20. Default: 20
currentPage - Int
The page of results to return. The default is 1. Default: 1

Example

Query
Copied to your clipboard
query dynamicBlocks(
  $input: DynamicBlocksFilterInput,
  $pageSize: Int,
  $currentPage: Int
) {
  dynamicBlocks(
    input: $input,
    pageSize: $pageSize,
    currentPage: $currentPage
  ) {
    items {
      ...DynamicBlockFragment
    }
    page_info {
      ...SearchResultPageInfoFragment
    }
    total_count
  }
}
Variables
Copied to your clipboard
{
  "input": DynamicBlocksFilterInput,
  "pageSize": 20,
  "currentPage": 1
}
Response
Copied to your clipboard
{
  "data": {
    "dynamicBlocks": {
      "items": [DynamicBlock],
      "page_info": SearchResultPageInfo,
      "total_count": 123
    }
  }
}

getHostedProUrl

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

Response: HostedProUrl

Arguments

NameDescription
input - HostedProUrlInput!
An input object that specifies the cart ID.

Example

Query
Copied to your clipboard
query getHostedProUrl($input: HostedProUrlInput!) {
  getHostedProUrl(input: $input) {
    secure_form_url
  }
}
Variables
Copied to your clipboard
{"input": HostedProUrlInput}
Response
Copied to your clipboard
{
  "data": {
    "getHostedProUrl": {
      "secure_form_url": "abc123"
    }
  }
}

getPayflowLinkToken

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

Response: PayflowLinkToken

Arguments

NameDescription
input - PayflowLinkTokenInput!
An input object that defines the requirements to receive a payment token.

Example

Query
Copied to your clipboard
query getPayflowLinkToken($input: PayflowLinkTokenInput!) {
  getPayflowLinkToken(input: $input) {
    mode
    paypal_url
    secure_token
    secure_token_id
  }
}
Variables
Copied to your clipboard
{"input": PayflowLinkTokenInput}
Response
Copied to your clipboard
{
  "data": {
    "getPayflowLinkToken": {
      "mode": "TEST",
      "paypal_url": "abc123",
      "secure_token": "xyz789",
      "secure_token_id": "xyz789"
    }
  }
}

getPaymentConfig

Retrieves the payment configuration for a given location

Response: PaymentConfigOutput

Arguments

NameDescription
location - PaymentLocation!
Defines the origin location for that payment request

Example

Query
Copied to your clipboard
query getPaymentConfig($location: PaymentLocation!) {
  getPaymentConfig(location: $location) {
    apple_pay {
      ...ApplePayConfigFragment
    }
    fastlane {
      ...FastlaneConfigFragment
    }
    google_pay {
      ...GooglePayConfigFragment
    }
    hosted_fields {
      ...HostedFieldsConfigFragment
    }
    smart_buttons {
      ...SmartButtonsConfigFragment
    }
  }
}
Variables
Copied to your clipboard
{"location": "PRODUCT_DETAIL"}
Response
Copied to your clipboard
{
  "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

NameDescription
cartId - String!
The customer cart ID
id - String!
PayPal order ID

Example

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

getPaymentSDK

Gets the payment SDK urls and values

Response: GetPaymentSDKOutput

Arguments

NameDescription
location - PaymentLocation!
Defines the origin location for that payment request

Example

Query
Copied to your clipboard
query getPaymentSDK($location: PaymentLocation!) {
  getPaymentSDK(location: $location) {
    sdkParams {
      ...PaymentSDKParamsItemFragment
    }
  }
}
Variables
Copied to your clipboard
{"location": "PRODUCT_DETAIL"}
Response
Copied to your clipboard
{
  "data": {
    "getPaymentSDK": {"sdkParams": [PaymentSDKParamsItem]}
  }
}

getVaultConfig

Retrieves the vault configuration

Response: VaultConfigOutput

Example

Query
Copied to your clipboard
query getVaultConfig {
  getVaultConfig {
    credit_card {
      ...VaultCreditCardConfigFragment
    }
  }
}
Response
Copied to your clipboard
{
  "data": {
    "getVaultConfig": {
      "credit_card": VaultCreditCardConfig
    }
  }
}

giftCardAccount

Return details about a specific gift card.

Response: GiftCardAccount

Arguments

NameDescription
input - GiftCardAccountInput!
An input object that specifies the gift card code.

Example

Query
Copied to your clipboard
query giftCardAccount($input: GiftCardAccountInput!) {
  giftCardAccount(input: $input) {
    balance {
      ...MoneyFragment
    }
    code
    expiration_date
  }
}
Variables
Copied to your clipboard
{"input": GiftCardAccountInput}
Response
Copied to your clipboard
{
  "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

NameDescription
giftRegistryUid - ID!
The unique ID of the registry to search for.

Example

Query
Copied to your clipboard
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
Copied to your clipboard
{"giftRegistryUid": "4"}
Response
Copied to your clipboard
{
  "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

NameDescription
email - String!
The registrant's email.

Example

Query
Copied to your clipboard
query giftRegistryEmailSearch($email: String!) {
  giftRegistryEmailSearch(email: $email) {
    event_date
    event_title
    gift_registry_uid
    location
    name
    type
  }
}
Variables
Copied to your clipboard
{"email": "abc123"}
Response
Copied to your clipboard
{
  "data": {
    "giftRegistryEmailSearch": [
      {
        "event_date": "abc123",
        "event_title": "abc123",
        "gift_registry_uid": 4,
        "location": "abc123",
        "name": "xyz789",
        "type": "xyz789"
      }
    ]
  }
}

giftRegistryIdSearch

Search for gift registries by specifying a registry URL key.

Response: [GiftRegistrySearchResult]

Arguments

NameDescription
giftRegistryUid - ID!
The unique ID of the gift registry.

Example

Query
Copied to your clipboard
query giftRegistryIdSearch($giftRegistryUid: ID!) {
  giftRegistryIdSearch(giftRegistryUid: $giftRegistryUid) {
    event_date
    event_title
    gift_registry_uid
    location
    name
    type
  }
}
Variables
Copied to your clipboard
{"giftRegistryUid": "4"}
Response
Copied to your clipboard
{
  "data": {
    "giftRegistryIdSearch": [
      {
        "event_date": "xyz789",
        "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

NameDescription
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
Copied to your clipboard
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
Copied to your clipboard
{
  "firstName": "abc123",
  "lastName": "xyz789",
  "giftRegistryTypeUid": "4"
}
Response
Copied to your clipboard
{
  "data": {
    "giftRegistryTypeSearch": [
      {
        "event_date": "abc123",
        "event_title": "xyz789",
        "gift_registry_uid": 4,
        "location": "abc123",
        "name": "abc123",
        "type": "abc123"
      }
    ]
  }
}

giftRegistryTypes

Get a list of available gift registry types.

Response: [GiftRegistryType]

Example

Query
Copied to your clipboard
query giftRegistryTypes {
  giftRegistryTypes {
    dynamic_attributes_metadata {
      ...GiftRegistryDynamicAttributeMetadataInterfaceFragment
    }
    label
    uid
  }
}
Response
Copied to your clipboard
{
  "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

NameDescription
input - GuestOrderInformationInput!

Example

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

guestOrderByToken

Retrieve guest order details based on token.

Response: CustomerOrder!

Arguments

NameDescription
input - OrderTokenInput!

Example

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

isCompanyAdminEmailAvailable

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

Response: IsCompanyAdminEmailAvailableOutput

Arguments

NameDescription
email - String!

Example

Query
Copied to your clipboard
query isCompanyAdminEmailAvailable($email: String!) {
  isCompanyAdminEmailAvailable(email: $email) {
    is_email_available
  }
}
Variables
Copied to your clipboard
{"email": "xyz789"}
Response
Copied to your clipboard
{"data": {"isCompanyAdminEmailAvailable": {"is_email_available": false}}}

isCompanyEmailAvailable

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

Response: IsCompanyEmailAvailableOutput

Arguments

NameDescription
email - String!

Example

Query
Copied to your clipboard
query isCompanyEmailAvailable($email: String!) {
  isCompanyEmailAvailable(email: $email) {
    is_email_available
  }
}
Variables
Copied to your clipboard
{"email": "abc123"}
Response
Copied to your clipboard
{"data": {"isCompanyEmailAvailable": {"is_email_available": true}}}

isCompanyRoleNameAvailable

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

Response: IsCompanyRoleNameAvailableOutput

Arguments

NameDescription
name - String!

Example

Query
Copied to your clipboard
query isCompanyRoleNameAvailable($name: String!) {
  isCompanyRoleNameAvailable(name: $name) {
    is_role_name_available
  }
}
Variables
Copied to your clipboard
{"name": "abc123"}
Response
Copied to your clipboard
{"data": {"isCompanyRoleNameAvailable": {"is_role_name_available": false}}}

isCompanyUserEmailAvailable

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

Response: IsCompanyUserEmailAvailableOutput

Arguments

NameDescription
email - String!

Example

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

isEmailAvailable

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

Response: IsEmailAvailableOutput

Arguments

NameDescription
email - String!
The email address to check.

Example

Query
Copied to your clipboard
query isEmailAvailable($email: String!) {
  isEmailAvailable(email: $email) {
    is_email_available
  }
}
Variables
Copied to your clipboard
{"email": "xyz789"}
Response
Copied to your clipboard
{"data": {"isEmailAvailable": {"is_email_available": true}}}

negotiableQuote

Retrieve the specified negotiable quote.

Response: NegotiableQuote

Arguments

NameDescription
uid - ID!

Example

Query
Copied to your clipboard
query negotiableQuote($uid: ID!) {
  negotiableQuote(uid: $uid) {
    available_payment_methods {
      ...AvailablePaymentMethodFragment
    }
    billing_address {
      ...NegotiableQuoteBillingAddressFragment
    }
    buyer {
      ...NegotiableQuoteUserFragment
    }
    comments {
      ...NegotiableQuoteCommentFragment
    }
    created_at
    email
    history {
      ...NegotiableQuoteHistoryEntryFragment
    }
    is_virtual
    items {
      ...CartItemInterfaceFragment
    }
    name
    prices {
      ...CartPricesFragment
    }
    selected_payment_method {
      ...SelectedPaymentMethodFragment
    }
    shipping_addresses {
      ...NegotiableQuoteShippingAddressFragment
    }
    status
    total_quantity
    uid
    updated_at
  }
}
Variables
Copied to your clipboard
{"uid": "4"}
Response
Copied to your clipboard
{
  "data": {
    "negotiableQuote": {
      "available_payment_methods": [
        AvailablePaymentMethod
      ],
      "billing_address": NegotiableQuoteBillingAddress,
      "buyer": NegotiableQuoteUser,
      "comments": [NegotiableQuoteComment],
      "created_at": "xyz789",
      "email": "abc123",
      "history": [NegotiableQuoteHistoryEntry],
      "is_virtual": false,
      "items": [CartItemInterface],
      "name": "xyz789",
      "prices": CartPrices,
      "selected_payment_method": SelectedPaymentMethod,
      "shipping_addresses": [
        NegotiableQuoteShippingAddress
      ],
      "status": "SUBMITTED",
      "total_quantity": 987.65,
      "uid": 4,
      "updated_at": "xyz789"
    }
  }
}

negotiableQuoteTemplate

Retrieve the specified negotiable quote template.

Response: NegotiableQuoteTemplate

Arguments

NameDescription
templateId - ID!

Example

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

negotiableQuoteTemplates

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

Response: NegotiableQuoteTemplatesOutput

Arguments

NameDescription
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
Copied to your clipboard
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
Copied to your clipboard
{
  "filter": NegotiableQuoteTemplateFilterInput,
  "pageSize": 20,
  "currentPage": 1,
  "sort": NegotiableQuoteTemplateSortInput
}
Response
Copied to your clipboard
{
  "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

NameDescription
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
Copied to your clipboard
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
Copied to your clipboard
{
  "filter": NegotiableQuoteFilterInput,
  "pageSize": 20,
  "currentPage": 1,
  "sort": NegotiableQuoteSortInput
}
Response
Copied to your clipboard
{
  "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

NameDescription
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
Copied to your clipboard
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
Copied to your clipboard
{
  "area": AreaInput,
  "filters": PickupLocationFilterInput,
  "sort": PickupLocationSortInput,
  "pageSize": 20,
  "currentPage": 1,
  "productsInfo": [ProductInfoInput]
}
Response
Copied to your clipboard
{
  "data": {
    "pickupLocations": {
      "items": [PickupLocation],
      "page_info": SearchResultPageInfo,
      "total_count": 987
    }
  }
}

productReviewRatingsMetadata

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

Response: ProductReviewRatingsMetadata!

Example

Query
Copied to your clipboard
query productReviewRatingsMetadata {
  productReviewRatingsMetadata {
    items {
      ...ProductReviewRatingMetadataFragment
    }
  }
}
Response
Copied to your clipboard
{
  "data": {
    "productReviewRatingsMetadata": {
      "items": [ProductReviewRatingMetadata]
    }
  }
}

products

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

Response: Products

Arguments

NameDescription
search - String
One or more keywords to use in a full-text search.
filter - ProductAttributeFilterInput
The product attributes to search for and return.
pageSize - Int
The maximum number of results to return at once. The default value is 20. Default: 20
currentPage - Int
The page of results to return. The default value is 1. Default: 1
sort - ProductAttributeSortInput
Specifies which attributes to sort on, and whether to return the results in ascending or descending order.

Example

Query
Copied to your clipboard
query products(
  $search: String,
  $filter: ProductAttributeFilterInput,
  $pageSize: Int,
  $currentPage: Int,
  $sort: ProductAttributeSortInput
) {
  products(
    search: $search,
    filter: $filter,
    pageSize: $pageSize,
    currentPage: $currentPage,
    sort: $sort
  ) {
    aggregations {
      ...AggregationFragment
    }
    filters {
      ...LayerFilterFragment
    }
    items {
      ...ProductInterfaceFragment
    }
    page_info {
      ...SearchResultPageInfoFragment
    }
    sort_fields {
      ...SortFieldsFragment
    }
    suggestions {
      ...SearchSuggestionFragment
    }
    total_count
  }
}
Variables
Copied to your clipboard
{
  "search": "xyz789",
  "filter": ProductAttributeFilterInput,
  "pageSize": 20,
  "currentPage": 1,
  "sort": ProductAttributeSortInput
}
Response
Copied to your clipboard
{
  "data": {
    "products": {
      "aggregations": [Aggregation],
      "filters": [LayerFilter],
      "items": [ProductInterface],
      "page_info": SearchResultPageInfo,
      "sort_fields": SortFields,
      "suggestions": [SearchSuggestion],
      "total_count": 123
    }
  }
}

recaptchaFormConfig

Response: ReCaptchaConfigOutput

Arguments

NameDescription
formType - ReCaptchaFormEnum!

Example

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

recaptchaV3Config

Returns details about Google reCAPTCHA V3-Invisible configuration.

Response: ReCaptchaConfigurationV3

Example

Query
Copied to your clipboard
query recaptchaV3Config {
  recaptchaV3Config {
    badge_position
    failure_message
    forms
    is_enabled
    language_code
    minimum_score
    theme
    website_key
  }
}
Response
Copied to your clipboard
{
  "data": {
    "recaptchaV3Config": {
      "badge_position": "xyz789",
      "failure_message": "abc123",
      "forms": ["PLACE_ORDER"],
      "is_enabled": true,
      "language_code": "abc123",
      "minimum_score": 123.45,
      "theme": "xyz789",
      "website_key": "abc123"
    }
  }
}

route

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

Response: RoutableInterface

Arguments

NameDescription
url - String!
A `url_key` appended by the `url_suffix, if one exists.

Example

Query
Copied to your clipboard
query route($url: String!) {
  route(url: $url) {
    redirect_code
    relative_url
    type
  }
}
Variables
Copied to your clipboard
{"url": "abc123"}
Response
Copied to your clipboard
{
  "data": {
    "route": {
      "redirect_code": 123,
      "relative_url": "abc123",
      "type": "CMS_PAGE"
    }
  }
}

storeConfig

Return details about the store's configuration.

Response: StoreConfig

Example

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

urlResolver

Deprecated

Use the route query instead.

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

Response: EntityUrl

Arguments

NameDescription
url - String!
A `url_key` appended by the `url_suffix, if one exists.

Example

Query
Copied to your clipboard
query urlResolver($url: String!) {
  urlResolver(url: $url) {
    canonical_url
    entity_uid
    id
    redirectCode
    relative_url
    type
  }
}
Variables
Copied to your clipboard
{"url": "xyz789"}
Response
Copied to your clipboard
{
  "data": {
    "urlResolver": {
      "canonical_url": "abc123",
      "entity_uid": "4",
      "id": 987,
      "redirectCode": 123,
      "relative_url": "xyz789",
      "type": "CMS_PAGE"
    }
  }
}

wishlist

Deprecated

Moved under Customer.wishlist.

Return the contents of a customer's wish list.

Response: WishlistOutput

Example

Query
Copied to your clipboard
query wishlist {
  wishlist {
    items {
      ...WishlistItemFragment
    }
    items_count
    name
    sharing_code
    updated_at
  }
}
Response
Copied to your clipboard
{
  "data": {
    "wishlist": {
      "items": [WishlistItem],
      "items_count": 987,
      "name": "xyz789",
      "sharing_code": "xyz789",
      "updated_at": "abc123"
    }
  }
}

Mutations

acceptCompanyInvitation

Accept invitation to the company.

Response: CompanyInvitationOutput

Arguments

NameDescription
input - CompanyInvitationInput!

Example

Query
Copied to your clipboard
mutation acceptCompanyInvitation($input: CompanyInvitationInput!) {
  acceptCompanyInvitation(input: $input) {
    success
  }
}
Variables
Copied to your clipboard
{"input": CompanyInvitationInput}
Response
Copied to your clipboard
{"data": {"acceptCompanyInvitation": {"success": true}}}

acceptNegotiableQuoteTemplate

Update an existing negotiable quote template.

Response: NegotiableQuoteTemplate

Arguments

NameDescription
input - AcceptNegotiableQuoteTemplateInput!
An input object that contains the data to update a negotiable quote template.

Example

Query
Copied to your clipboard
mutation acceptNegotiableQuoteTemplate($input: AcceptNegotiableQuoteTemplateInput!) {
  acceptNegotiableQuoteTemplate(input: $input) {
    buyer {
      ...NegotiableQuoteUserFragment
    }
    comments {
      ...NegotiableQuoteCommentFragment
    }
    expiration_date
    history {
      ...NegotiableQuoteHistoryEntryFragment
    }
    is_min_max_qty_used
    is_virtual
    items {
      ...CartItemInterfaceFragment
    }
    max_order_commitment
    min_order_commitment
    name
    notifications {
      ...QuoteTemplateNotificationMessageFragment
    }
    prices {
      ...CartPricesFragment
    }
    reference_document_links {
      ...NegotiableQuoteReferenceDocumentLinkFragment
    }
    shipping_addresses {
      ...NegotiableQuoteShippingAddressFragment
    }
    status
    template_id
    total_quantity
  }
}
Variables
Copied to your clipboard
{"input": AcceptNegotiableQuoteTemplateInput}
Response
Copied to your clipboard
{
  "data": {
    "acceptNegotiableQuoteTemplate": {
      "buyer": NegotiableQuoteUser,
      "comments": [NegotiableQuoteComment],
      "expiration_date": "xyz789",
      "history": [NegotiableQuoteHistoryEntry],
      "is_min_max_qty_used": true,
      "is_virtual": true,
      "items": [CartItemInterface],
      "max_order_commitment": 987,
      "min_order_commitment": 987,
      "name": "abc123",
      "notifications": [QuoteTemplateNotificationMessage],
      "prices": CartPrices,
      "reference_document_links": [
        NegotiableQuoteReferenceDocumentLink
      ],
      "shipping_addresses": [
        NegotiableQuoteShippingAddress
      ],
      "status": "abc123",
      "template_id": 4,
      "total_quantity": 987.65
    }
  }
}

addBundleProductsToCart

Add one or more bundle products to the specified cart. We recommend using addProductsToCart instead.

Response: AddBundleProductsToCartOutput

Arguments

NameDescription
input - AddBundleProductsToCartInput
An input object that defines which bundle products to add to the cart.

Example

Query
Copied to your clipboard
mutation addBundleProductsToCart($input: AddBundleProductsToCartInput) {
  addBundleProductsToCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": AddBundleProductsToCartInput}
Response
Copied to your clipboard
{"data": {"addBundleProductsToCart": {"cart": Cart}}}

addConfigurableProductsToCart

Add one or more configurable products to the specified cart. We recommend using addProductsToCart instead.

Response: AddConfigurableProductsToCartOutput

Arguments

NameDescription
input - AddConfigurableProductsToCartInput
An input object that defines which configurable products to add to the cart.

Example

Query
Copied to your clipboard
mutation addConfigurableProductsToCart($input: AddConfigurableProductsToCartInput) {
  addConfigurableProductsToCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": AddConfigurableProductsToCartInput}
Response
Copied to your clipboard
{
  "data": {
    "addConfigurableProductsToCart": {"cart": Cart}
  }
}

addDownloadableProductsToCart

Add one or more downloadable products to the specified cart. We recommend using addProductsToCart instead.

Response: AddDownloadableProductsToCartOutput

Arguments

NameDescription
input - AddDownloadableProductsToCartInput
An input object that defines which downloadable products to add to the cart.

Example

Query
Copied to your clipboard
mutation addDownloadableProductsToCart($input: AddDownloadableProductsToCartInput) {
  addDownloadableProductsToCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": AddDownloadableProductsToCartInput}
Response
Copied to your clipboard
{
  "data": {
    "addDownloadableProductsToCart": {"cart": Cart}
  }
}

addGiftRegistryRegistrants

Add registrants to the specified gift registry.

Response: AddGiftRegistryRegistrantsOutput

Arguments

NameDescription
giftRegistryUid - ID!
The unique ID of the gift registry.
registrants - [AddGiftRegistryRegistrantInput!]!
An array registrants to add.

Example

Query
Copied to your clipboard
mutation addGiftRegistryRegistrants(
  $giftRegistryUid: ID!,
  $registrants: [AddGiftRegistryRegistrantInput!]!
) {
  addGiftRegistryRegistrants(
    giftRegistryUid: $giftRegistryUid,
    registrants: $registrants
  ) {
    gift_registry {
      ...GiftRegistryFragment
    }
  }
}
Variables
Copied to your clipboard
{
  "giftRegistryUid": "4",
  "registrants": [AddGiftRegistryRegistrantInput]
}
Response
Copied to your clipboard
{
  "data": {
    "addGiftRegistryRegistrants": {
      "gift_registry": GiftRegistry
    }
  }
}

addProductsToCart

Add any type of product to the cart.

Response: AddProductsToCartOutput

Arguments

NameDescription
cartId - String!
The cart ID of the shopper.
cartItems - [CartItemInput!]!
An array that defines the products to add to the cart.

Example

Query
Copied to your clipboard
mutation addProductsToCart(
  $cartId: String!,
  $cartItems: [CartItemInput!]!
) {
  addProductsToCart(
    cartId: $cartId,
    cartItems: $cartItems
  ) {
    cart {
      ...CartFragment
    }
    user_errors {
      ...ErrorFragment
    }
  }
}
Variables
Copied to your clipboard
{
  "cartId": "abc123",
  "cartItems": [CartItemInput]
}
Response
Copied to your clipboard
{
  "data": {
    "addProductsToCart": {
      "cart": Cart,
      "user_errors": [Error]
    }
  }
}

addProductsToCompareList

Add products to the specified compare list.

Response: CompareList

Arguments

NameDescription
input - AddProductsToCompareListInput
An input object that defines which products to add to an existing compare list.

Example

Query
Copied to your clipboard
mutation addProductsToCompareList($input: AddProductsToCompareListInput) {
  addProductsToCompareList(input: $input) {
    attributes {
      ...ComparableAttributeFragment
    }
    item_count
    items {
      ...ComparableItemFragment
    }
    uid
  }
}
Variables
Copied to your clipboard
{"input": AddProductsToCompareListInput}
Response
Copied to your clipboard
{
  "data": {
    "addProductsToCompareList": {
      "attributes": [ComparableAttribute],
      "item_count": 123,
      "items": [ComparableItem],
      "uid": "4"
    }
  }
}

addProductsToNewCart

Creates a new cart and add any type of product to it

Response: AddProductsToNewCartOutput

Arguments

NameDescription
cartItems - [CartItemInput!]!
An array that defines the products to add to the new cart

Example

Query
Copied to your clipboard
mutation addProductsToNewCart($cartItems: [CartItemInput!]!) {
  addProductsToNewCart(cartItems: $cartItems) {
    cart {
      ...CartFragment
    }
    user_errors {
      ...CartUserInputErrorFragment
    }
  }
}
Variables
Copied to your clipboard
{"cartItems": [CartItemInput]}
Response
Copied to your clipboard
{
  "data": {
    "addProductsToNewCart": {
      "cart": Cart,
      "user_errors": [CartUserInputError]
    }
  }
}

addProductsToRequisitionList

Add items to the specified requisition list.

Response: AddProductsToRequisitionListOutput

Arguments

NameDescription
requisitionListUid - ID!
The unique ID of the requisition list.
requisitionListItems - [RequisitionListItemsInput!]!
An array of products to be added to the requisition list.

Example

Query
Copied to your clipboard
mutation addProductsToRequisitionList(
  $requisitionListUid: ID!,
  $requisitionListItems: [RequisitionListItemsInput!]!
) {
  addProductsToRequisitionList(
    requisitionListUid: $requisitionListUid,
    requisitionListItems: $requisitionListItems
  ) {
    requisition_list {
      ...RequisitionListFragment
    }
  }
}
Variables
Copied to your clipboard
{
  "requisitionListUid": 4,
  "requisitionListItems": [RequisitionListItemsInput]
}
Response
Copied to your clipboard
{
  "data": {
    "addProductsToRequisitionList": {
      "requisition_list": RequisitionList
    }
  }
}

addProductsToWishlist

Add one or more products to the specified wish list. This mutation supports all product types.

Response: AddProductsToWishlistOutput

Arguments

NameDescription
wishlistId - ID!
The ID of a wish list.
wishlistItems - [WishlistItemInput!]!
An array of products to add to the wish list.

Example

Query
Copied to your clipboard
mutation addProductsToWishlist(
  $wishlistId: ID!,
  $wishlistItems: [WishlistItemInput!]!
) {
  addProductsToWishlist(
    wishlistId: $wishlistId,
    wishlistItems: $wishlistItems
  ) {
    user_errors {
      ...WishListUserInputErrorFragment
    }
    wishlist {
      ...WishlistFragment
    }
  }
}
Variables
Copied to your clipboard
{
  "wishlistId": "4",
  "wishlistItems": [WishlistItemInput]
}
Response
Copied to your clipboard
{
  "data": {
    "addProductsToWishlist": {
      "user_errors": [WishListUserInputError],
      "wishlist": Wishlist
    }
  }
}

addPurchaseOrderComment

Add a comment to an existing purchase order.

Response: AddPurchaseOrderCommentOutput

Arguments

NameDescription
input - AddPurchaseOrderCommentInput!

Example

Query
Copied to your clipboard
mutation addPurchaseOrderComment($input: AddPurchaseOrderCommentInput!) {
  addPurchaseOrderComment(input: $input) {
    comment {
      ...PurchaseOrderCommentFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": AddPurchaseOrderCommentInput}
Response
Copied to your clipboard
{
  "data": {
    "addPurchaseOrderComment": {
      "comment": PurchaseOrderComment
    }
  }
}

addPurchaseOrderItemsToCart

Add purchase order items to the shopping cart.

Response: AddProductsToCartOutput

Arguments

NameDescription
input - AddPurchaseOrderItemsToCartInput!

Example

Query
Copied to your clipboard
mutation addPurchaseOrderItemsToCart($input: AddPurchaseOrderItemsToCartInput!) {
  addPurchaseOrderItemsToCart(input: $input) {
    cart {
      ...CartFragment
    }
    user_errors {
      ...ErrorFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": AddPurchaseOrderItemsToCartInput}
Response
Copied to your clipboard
{
  "data": {
    "addPurchaseOrderItemsToCart": {
      "cart": Cart,
      "user_errors": [Error]
    }
  }
}

addRequisitionListItemsToCart

Add items in the requisition list to the customer's cart.

Response: AddRequisitionListItemsToCartOutput

Arguments

NameDescription
requisitionListUid - ID!
The unique ID of the requisition list.
requisitionListItemUids - [ID!]
An array of UIDs presenting products to be added to the cart. If no UIDs are specified, all items in the requisition list will be added to the cart.

Example

Query
Copied to your clipboard
mutation addRequisitionListItemsToCart(
  $requisitionListUid: ID!,
  $requisitionListItemUids: [ID!]
) {
  addRequisitionListItemsToCart(
    requisitionListUid: $requisitionListUid,
    requisitionListItemUids: $requisitionListItemUids
  ) {
    add_requisition_list_items_to_cart_user_errors {
      ...AddRequisitionListItemToCartUserErrorFragment
    }
    cart {
      ...CartFragment
    }
    status
  }
}
Variables
Copied to your clipboard
{"requisitionListUid": 4, "requisitionListItemUids": [4]}
Response
Copied to your clipboard
{
  "data": {
    "addRequisitionListItemsToCart": {
      "add_requisition_list_items_to_cart_user_errors": [
        AddRequisitionListItemToCartUserError
      ],
      "cart": Cart,
      "status": true
    }
  }
}

addReturnComment

Add a comment to an existing return.

Response: AddReturnCommentOutput

Arguments

NameDescription
input - AddReturnCommentInput!
An input object that defines a return comment.

Example

Query
Copied to your clipboard
mutation addReturnComment($input: AddReturnCommentInput!) {
  addReturnComment(input: $input) {
    return {
      ...ReturnFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": AddReturnCommentInput}
Response
Copied to your clipboard
{"data": {"addReturnComment": {"return": Return}}}

addReturnTracking

Add tracking information to the return.

Response: AddReturnTrackingOutput

Arguments

NameDescription
input - AddReturnTrackingInput!
An input object that defines tracking information.

Example

Query
Copied to your clipboard
mutation addReturnTracking($input: AddReturnTrackingInput!) {
  addReturnTracking(input: $input) {
    return {
      ...ReturnFragment
    }
    return_shipping_tracking {
      ...ReturnShippingTrackingFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": AddReturnTrackingInput}
Response
Copied to your clipboard
{
  "data": {
    "addReturnTracking": {
      "return": Return,
      "return_shipping_tracking": ReturnShippingTracking
    }
  }
}

addSimpleProductsToCart

Add one or more simple products to the specified cart. We recommend using addProductsToCart instead.

Response: AddSimpleProductsToCartOutput

Arguments

NameDescription
input - AddSimpleProductsToCartInput
An input object that defines which simple products to add to the cart.

Example

Query
Copied to your clipboard
mutation addSimpleProductsToCart($input: AddSimpleProductsToCartInput) {
  addSimpleProductsToCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": AddSimpleProductsToCartInput}
Response
Copied to your clipboard
{"data": {"addSimpleProductsToCart": {"cart": Cart}}}

addVirtualProductsToCart

Add one or more virtual products to the specified cart. We recommend using addProductsToCart instead.

Response: AddVirtualProductsToCartOutput

Arguments

NameDescription
input - AddVirtualProductsToCartInput
An input object that defines which virtual products to add to the cart.

Example

Query
Copied to your clipboard
mutation addVirtualProductsToCart($input: AddVirtualProductsToCartInput) {
  addVirtualProductsToCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": AddVirtualProductsToCartInput}
Response
Copied to your clipboard
{"data": {"addVirtualProductsToCart": {"cart": Cart}}}

addWishlistItemsToCart

Add items in the specified wishlist to the customer's cart.

Response: AddWishlistItemsToCartOutput

Arguments

NameDescription
wishlistId - ID!
The unique ID of the wish list
wishlistItemIds - [ID!]
An array of IDs representing products to be added to the cart. If no IDs are specified, all items in the wishlist will be added to the cart

Example

Query
Copied to your clipboard
mutation addWishlistItemsToCart(
  $wishlistId: ID!,
  $wishlistItemIds: [ID!]
) {
  addWishlistItemsToCart(
    wishlistId: $wishlistId,
    wishlistItemIds: $wishlistItemIds
  ) {
    add_wishlist_items_to_cart_user_errors {
      ...WishlistCartUserInputErrorFragment
    }
    status
    wishlist {
      ...WishlistFragment
    }
  }
}
Variables
Copied to your clipboard
{"wishlistId": 4, "wishlistItemIds": [4]}
Response
Copied to your clipboard
{
  "data": {
    "addWishlistItemsToCart": {
      "add_wishlist_items_to_cart_user_errors": [
        WishlistCartUserInputError
      ],
      "status": true,
      "wishlist": Wishlist
    }
  }
}

applyCouponToCart

Apply a pre-defined coupon code to the specified cart.

Response: ApplyCouponToCartOutput

Arguments

NameDescription
input - ApplyCouponToCartInput
An input object that defines the coupon code to apply to the cart.

Example

Query
Copied to your clipboard
mutation applyCouponToCart($input: ApplyCouponToCartInput) {
  applyCouponToCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": ApplyCouponToCartInput}
Response
Copied to your clipboard
{"data": {"applyCouponToCart": {"cart": Cart}}}

applyCouponsToCart

Apply a pre-defined coupon code to the specified cart.

Response: ApplyCouponToCartOutput

Arguments

NameDescription
input - ApplyCouponsToCartInput
An input object that defines the coupon code to apply to the cart.

Example

Query
Copied to your clipboard
mutation applyCouponsToCart($input: ApplyCouponsToCartInput) {
  applyCouponsToCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": ApplyCouponsToCartInput}
Response
Copied to your clipboard
{"data": {"applyCouponsToCart": {"cart": Cart}}}

applyGiftCardToCart

Apply a pre-defined gift card code to the specified cart.

Response: ApplyGiftCardToCartOutput

Arguments

NameDescription
input - ApplyGiftCardToCartInput
An input object that specifies the gift card code and cart.

Example

Query
Copied to your clipboard
mutation applyGiftCardToCart($input: ApplyGiftCardToCartInput) {
  applyGiftCardToCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": ApplyGiftCardToCartInput}
Response
Copied to your clipboard
{"data": {"applyGiftCardToCart": {"cart": Cart}}}

applyRewardPointsToCart

Apply all available points, up to the cart total. Partial redemption is not available.

Response: ApplyRewardPointsToCartOutput

Arguments

NameDescription
cartId - ID!

Example

Query
Copied to your clipboard
mutation applyRewardPointsToCart($cartId: ID!) {
  applyRewardPointsToCart(cartId: $cartId) {
    cart {
      ...CartFragment
    }
  }
}
Variables
Copied to your clipboard
{"cartId": "4"}
Response
Copied to your clipboard
{"data": {"applyRewardPointsToCart": {"cart": Cart}}}

applyStoreCreditToCart

Apply store credit to the specified cart.

Response: ApplyStoreCreditToCartOutput

Arguments

NameDescription
input - ApplyStoreCreditToCartInput!
An input object that specifies the cart ID.

Example

Query
Copied to your clipboard
mutation applyStoreCreditToCart($input: ApplyStoreCreditToCartInput!) {
  applyStoreCreditToCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": ApplyStoreCreditToCartInput}
Response
Copied to your clipboard
{"data": {"applyStoreCreditToCart": {"cart": Cart}}}

approvePurchaseOrders

Approve purchase orders.

Response: PurchaseOrdersActionOutput

Arguments

NameDescription
input - PurchaseOrdersActionInput!

Example

Query
Copied to your clipboard
mutation approvePurchaseOrders($input: PurchaseOrdersActionInput!) {
  approvePurchaseOrders(input: $input) {
    errors {
      ...PurchaseOrderActionErrorFragment
    }
    purchase_orders {
      ...PurchaseOrderFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": PurchaseOrdersActionInput}
Response
Copied to your clipboard
{
  "data": {
    "approvePurchaseOrders": {
      "errors": [PurchaseOrderActionError],
      "purchase_orders": [PurchaseOrder]
    }
  }
}

assignCompareListToCustomer

Assign the specified compare list to the logged in customer.

Response: AssignCompareListToCustomerOutput

Arguments

NameDescription
uid - ID!
The unique ID of the compare list to be assigned.

Example

Query
Copied to your clipboard
mutation assignCompareListToCustomer($uid: ID!) {
  assignCompareListToCustomer(uid: $uid) {
    compare_list {
      ...CompareListFragment
    }
    result
  }
}
Variables
Copied to your clipboard
{"uid": 4}
Response
Copied to your clipboard
{
  "data": {
    "assignCompareListToCustomer": {
      "compare_list": CompareList,
      "result": true
    }
  }
}

assignCustomerToGuestCart

Assign a logged-in customer to the specified guest shopping cart.

Response: Cart!

Arguments

NameDescription
cart_id - String!

Example

Query
Copied to your clipboard
mutation assignCustomerToGuestCart($cart_id: String!) {
  assignCustomerToGuestCart(cart_id: $cart_id) {
    applied_coupon {
      ...AppliedCouponFragment
    }
    applied_coupons {
      ...AppliedCouponFragment
    }
    applied_gift_cards {
      ...AppliedGiftCardFragment
    }
    applied_reward_points {
      ...RewardPointsAmountFragment
    }
    applied_store_credit {
      ...AppliedStoreCreditFragment
    }
    available_gift_wrappings {
      ...GiftWrappingFragment
    }
    available_payment_methods {
      ...AvailablePaymentMethodFragment
    }
    billing_address {
      ...BillingCartAddressFragment
    }
    email
    gift_message {
      ...GiftMessageFragment
    }
    gift_receipt_included
    gift_wrapping {
      ...GiftWrappingFragment
    }
    id
    is_virtual
    items {
      ...CartItemInterfaceFragment
    }
    itemsV2 {
      ...CartItemsFragment
    }
    prices {
      ...CartPricesFragment
    }
    printed_card_included
    rules {
      ...CartRuleStorefrontFragment
    }
    selected_payment_method {
      ...SelectedPaymentMethodFragment
    }
    shipping_addresses {
      ...ShippingCartAddressFragment
    }
    total_quantity
  }
}
Variables
Copied to your clipboard
{"cart_id": "xyz789"}
Response
Copied to your clipboard
{
  "data": {
    "assignCustomerToGuestCart": {
      "applied_coupon": AppliedCoupon,
      "applied_coupons": [AppliedCoupon],
      "applied_gift_cards": [AppliedGiftCard],
      "applied_reward_points": RewardPointsAmount,
      "applied_store_credit": AppliedStoreCredit,
      "available_gift_wrappings": [GiftWrapping],
      "available_payment_methods": [
        AvailablePaymentMethod
      ],
      "billing_address": BillingCartAddress,
      "email": "abc123",
      "gift_message": GiftMessage,
      "gift_receipt_included": false,
      "gift_wrapping": GiftWrapping,
      "id": 4,
      "is_virtual": true,
      "items": [CartItemInterface],
      "itemsV2": CartItems,
      "prices": CartPrices,
      "printed_card_included": true,
      "rules": [CartRuleStorefront],
      "selected_payment_method": SelectedPaymentMethod,
      "shipping_addresses": [ShippingCartAddress],
      "total_quantity": 123.45
    }
  }
}

cancelNegotiableQuoteTemplate

Cancel a negotiable quote template

Response: NegotiableQuoteTemplate

Arguments

NameDescription
input - CancelNegotiableQuoteTemplateInput!
An input object that cancels a negotiable quote template.

Example

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

cancelOrder

Cancel the specified customer order.

Response: CancelOrderOutput

Arguments

NameDescription
input - CancelOrderInput!

Example

Query
Copied to your clipboard
mutation cancelOrder($input: CancelOrderInput!) {
  cancelOrder(input: $input) {
    error
    errorV2 {
      ...CancelOrderErrorFragment
    }
    order {
      ...CustomerOrderFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": CancelOrderInput}
Response
Copied to your clipboard
{
  "data": {
    "cancelOrder": {
      "error": "abc123",
      "errorV2": CancelOrderError,
      "order": CustomerOrder
    }
  }
}

cancelPurchaseOrders

Cancel purchase orders.

Response: PurchaseOrdersActionOutput

Arguments

NameDescription
input - PurchaseOrdersActionInput!

Example

Query
Copied to your clipboard
mutation cancelPurchaseOrders($input: PurchaseOrdersActionInput!) {
  cancelPurchaseOrders(input: $input) {
    errors {
      ...PurchaseOrderActionErrorFragment
    }
    purchase_orders {
      ...PurchaseOrderFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": PurchaseOrdersActionInput}
Response
Copied to your clipboard
{
  "data": {
    "cancelPurchaseOrders": {
      "errors": [PurchaseOrderActionError],
      "purchase_orders": [PurchaseOrder]
    }
  }
}

changeCustomerPassword

Change the password for the logged-in customer.

Response: Customer

Arguments

NameDescription
currentPassword - String!
The customer's original password.
newPassword - String!
The customer's updated password.

Example

Query
Copied to your clipboard
mutation changeCustomerPassword(
  $currentPassword: String!,
  $newPassword: String!
) {
  changeCustomerPassword(
    currentPassword: $currentPassword,
    newPassword: $newPassword
  ) {
    addresses {
      ...CustomerAddressFragment
    }
    addressesV2 {
      ...CustomerAddressesFragment
    }
    allow_remote_shopping_assistance
    companies {
      ...UserCompaniesOutputFragment
    }
    compare_list {
      ...CompareListFragment
    }
    confirmation_status
    created_at
    custom_attributes {
      ...AttributeValueInterfaceFragment
    }
    date_of_birth
    default_billing
    default_shipping
    dob
    email
    firstname
    gender
    gift_registries {
      ...GiftRegistryFragment
    }
    gift_registry {
      ...GiftRegistryFragment
    }
    group {
      ...CustomerGroupStorefrontFragment
    }
    group_id
    id
    is_subscribed
    job_title
    lastname
    middlename
    orders {
      ...CustomerOrdersFragment
    }
    prefix
    purchase_order {
      ...PurchaseOrderFragment
    }
    purchase_order_approval_rule {
      ...PurchaseOrderApprovalRuleFragment
    }
    purchase_order_approval_rule_metadata {
      ...PurchaseOrderApprovalRuleMetadataFragment
    }
    purchase_order_approval_rules {
      ...PurchaseOrderApprovalRulesFragment
    }
    purchase_orders {
      ...PurchaseOrdersFragment
    }
    purchase_orders_enabled
    requisition_lists {
      ...RequisitionListsFragment
    }
    return {
      ...ReturnFragment
    }
    returns {
      ...ReturnsFragment
    }
    reviews {
      ...ProductReviewsFragment
    }
    reward_points {
      ...RewardPointsFragment
    }
    role {
      ...CompanyRoleFragment
    }
    segments {
      ...CustomerSegmentStorefrontFragment
    }
    status
    store_credit {
      ...CustomerStoreCreditFragment
    }
    structure_id
    suffix
    taxvat
    team {
      ...CompanyTeamFragment
    }
    telephone
    wishlist {
      ...WishlistFragment
    }
    wishlist_v2 {
      ...WishlistFragment
    }
    wishlists {
      ...WishlistFragment
    }
  }
}
Variables
Copied to your clipboard
{
  "currentPassword": "abc123",
  "newPassword": "xyz789"
}
Response
Copied to your clipboard
{
  "data": {
    "changeCustomerPassword": {
      "addresses": [CustomerAddress],
      "addressesV2": CustomerAddresses,
      "allow_remote_shopping_assistance": true,
      "companies": UserCompaniesOutput,
      "compare_list": CompareList,
      "confirmation_status": "ACCOUNT_CONFIRMED",
      "created_at": "abc123",
      "custom_attributes": [AttributeValueInterface],
      "date_of_birth": "abc123",
      "default_billing": "abc123",
      "default_shipping": "xyz789",
      "dob": "xyz789",
      "email": "abc123",
      "firstname": "xyz789",
      "gender": 123,
      "gift_registries": [GiftRegistry],
      "gift_registry": GiftRegistry,
      "group": CustomerGroupStorefront,
      "group_id": 123,
      "id": 4,
      "is_subscribed": false,
      "job_title": "abc123",
      "lastname": "abc123",
      "middlename": "abc123",
      "orders": CustomerOrders,
      "prefix": "xyz789",
      "purchase_order": PurchaseOrder,
      "purchase_order_approval_rule": PurchaseOrderApprovalRule,
      "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata,
      "purchase_order_approval_rules": PurchaseOrderApprovalRules,
      "purchase_orders": PurchaseOrders,
      "purchase_orders_enabled": true,
      "requisition_lists": RequisitionLists,
      "return": Return,
      "returns": Returns,
      "reviews": ProductReviews,
      "reward_points": RewardPoints,
      "role": CompanyRole,
      "segments": [CustomerSegmentStorefront],
      "status": "ACTIVE",
      "store_credit": CustomerStoreCredit,
      "structure_id": 4,
      "suffix": "abc123",
      "taxvat": "xyz789",
      "team": CompanyTeam,
      "telephone": "xyz789",
      "wishlist": Wishlist,
      "wishlist_v2": Wishlist,
      "wishlists": [Wishlist]
    }
  }
}

clearCart

Remove all items from the specified cart.

Response: ClearCartOutput!

Arguments

NameDescription
input - ClearCartInput!
An input object that defines cart ID of the shopper.

Example

Query
Copied to your clipboard
mutation clearCart($input: ClearCartInput!) {
  clearCart(input: $input) {
    cart {
      ...CartFragment
    }
    errors {
      ...ClearCartErrorFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": ClearCartInput}
Response
Copied to your clipboard
{
  "data": {
    "clearCart": {
      "cart": Cart,
      "errors": [ClearCartError]
    }
  }
}

clearCustomerCart

Remove all items from the specified cart.

Response: ClearCustomerCartOutput

Arguments

NameDescription
cartUid - String!
The masked ID of the cart.

Example

Query
Copied to your clipboard
mutation clearCustomerCart($cartUid: String!) {
  clearCustomerCart(cartUid: $cartUid) {
    cart {
      ...CartFragment
    }
    status
  }
}
Variables
Copied to your clipboard
{"cartUid": "xyz789"}
Response
Copied to your clipboard
{
  "data": {
    "clearCustomerCart": {"cart": Cart, "status": false}
  }
}

clearWishlist

Remove all the products from the specified wish list.

Response: RemoveProductsFromWishlistOutput

Arguments

NameDescription
wishlistId - ID!
The ID of a wish list.

Example

Query
Copied to your clipboard
mutation clearWishlist($wishlistId: ID!) {
  clearWishlist(wishlistId: $wishlistId) {
    user_errors {
      ...WishListUserInputErrorFragment
    }
    wishlist {
      ...WishlistFragment
    }
  }
}
Variables
Copied to your clipboard
{"wishlistId": "4"}
Response
Copied to your clipboard
{
  "data": {
    "clearWishlist": {
      "user_errors": [WishListUserInputError],
      "wishlist": Wishlist
    }
  }
}

closeNegotiableQuotes

Mark a negotiable quote as closed. The negotiable quote is still visible on the storefront.

Response: CloseNegotiableQuotesOutput

Arguments

NameDescription
input - CloseNegotiableQuotesInput!
An input object that closes a negotiable quote.

Example

Query
Copied to your clipboard
mutation closeNegotiableQuotes($input: CloseNegotiableQuotesInput!) {
  closeNegotiableQuotes(input: $input) {
    closed_quotes {
      ...NegotiableQuoteFragment
    }
    negotiable_quotes {
      ...NegotiableQuotesOutputFragment
    }
    operation_results {
      ... on NegotiableQuoteUidOperationSuccess {
        ...NegotiableQuoteUidOperationSuccessFragment
      }
      ... on CloseNegotiableQuoteOperationFailure {
        ...CloseNegotiableQuoteOperationFailureFragment
      }
    }
    result_status
  }
}
Variables
Copied to your clipboard
{"input": CloseNegotiableQuotesInput}
Response
Copied to your clipboard
{
  "data": {
    "closeNegotiableQuotes": {
      "closed_quotes": [NegotiableQuote],
      "negotiable_quotes": NegotiableQuotesOutput,
      "operation_results": [
        NegotiableQuoteUidOperationSuccess
      ],
      "result_status": "SUCCESS"
    }
  }
}

completeOrder

Synchronizes order details and place the order

Response: PlaceOrderOutput

Arguments

NameDescription
input - CompleteOrderInput
Describes the variables needed to complete or place the order

Example

Query
Copied to your clipboard
mutation completeOrder($input: CompleteOrderInput) {
  completeOrder(input: $input) {
    errors {
      ...PlaceOrderErrorFragment
    }
    order {
      ...OrderFragment
    }
    orderV2 {
      ...CustomerOrderFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": CompleteOrderInput}
Response
Copied to your clipboard
{
  "data": {
    "completeOrder": {
      "errors": [PlaceOrderError],
      "order": Order,
      "orderV2": CustomerOrder
    }
  }
}

confirmCancelOrder

Cancel the specified guest customer order.

Response: CancelOrderOutput

Arguments

NameDescription
input - ConfirmCancelOrderInput!

Example

Query
Copied to your clipboard
mutation confirmCancelOrder($input: ConfirmCancelOrderInput!) {
  confirmCancelOrder(input: $input) {
    error
    errorV2 {
      ...CancelOrderErrorFragment
    }
    order {
      ...CustomerOrderFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": ConfirmCancelOrderInput}
Response
Copied to your clipboard
{
  "data": {
    "confirmCancelOrder": {
      "error": "abc123",
      "errorV2": CancelOrderError,
      "order": CustomerOrder
    }
  }
}

confirmEmail

Confirms the email address for a customer.

Response: CustomerOutput

Arguments

NameDescription
input - ConfirmEmailInput!
An input object to identify the customer to confirm the email.

Example

Query
Copied to your clipboard
mutation confirmEmail($input: ConfirmEmailInput!) {
  confirmEmail(input: $input) {
    customer {
      ...CustomerFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": ConfirmEmailInput}
Response
Copied to your clipboard
{"data": {"confirmEmail": {"customer": Customer}}}

confirmReturn

Confirm the return.

Response: RequestReturnOutput

Arguments

NameDescription
input - ConfirmReturnInput!

Example

Query
Copied to your clipboard
mutation confirmReturn($input: ConfirmReturnInput!) {
  confirmReturn(input: $input) {
    return {
      ...ReturnFragment
    }
    returns {
      ...ReturnsFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": ConfirmReturnInput}
Response
Copied to your clipboard
{
  "data": {
    "confirmReturn": {
      "return": Return,
      "returns": Returns
    }
  }
}

contactUs

Send a 'Contact Us' email to the merchant.

Response: ContactUsOutput

Arguments

NameDescription
input - ContactUsInput!
An input object that defines shopper information.

Example

Query
Copied to your clipboard
mutation contactUs($input: ContactUsInput!) {
  contactUs(input: $input) {
    status
  }
}
Variables
Copied to your clipboard
{"input": ContactUsInput}
Response
Copied to your clipboard
{"data": {"contactUs": {"status": false}}}

copyItemsBetweenRequisitionLists

Copy items from one requisition list to another.

Response: CopyItemsFromRequisitionListsOutput

Arguments

NameDescription
sourceRequisitionListUid - ID!
The unique ID of the source requisition list.
destinationRequisitionListUid - ID
The unique ID of the destination requisition list. If null, a new requisition list will be created.
requisitionListItem - CopyItemsBetweenRequisitionListsInput
The list of products to copy.

Example

Query
Copied to your clipboard
mutation copyItemsBetweenRequisitionLists(
  $sourceRequisitionListUid: ID!,
  $destinationRequisitionListUid: ID,
  $requisitionListItem: CopyItemsBetweenRequisitionListsInput
) {
  copyItemsBetweenRequisitionLists(
    sourceRequisitionListUid: $sourceRequisitionListUid,
    destinationRequisitionListUid: $destinationRequisitionListUid,
    requisitionListItem: $requisitionListItem
  ) {
    requisition_list {
      ...RequisitionListFragment
    }
  }
}
Variables
Copied to your clipboard
{
  "sourceRequisitionListUid": "4",
  "destinationRequisitionListUid": 4,
  "requisitionListItem": CopyItemsBetweenRequisitionListsInput
}
Response
Copied to your clipboard
{
  "data": {
    "copyItemsBetweenRequisitionLists": {
      "requisition_list": RequisitionList
    }
  }
}

copyProductsBetweenWishlists

Copy products from one wish list to another. The original wish list is unchanged.

Response: CopyProductsBetweenWishlistsOutput

Arguments

NameDescription
sourceWishlistUid - ID!
The ID of the original wish list.
destinationWishlistUid - ID!
The ID of the target wish list.
wishlistItems - [WishlistItemCopyInput!]!
An array of items to copy.

Example

Query
Copied to your clipboard
mutation copyProductsBetweenWishlists(
  $sourceWishlistUid: ID!,
  $destinationWishlistUid: ID!,
  $wishlistItems: [WishlistItemCopyInput!]!
) {
  copyProductsBetweenWishlists(
    sourceWishlistUid: $sourceWishlistUid,
    destinationWishlistUid: $destinationWishlistUid,
    wishlistItems: $wishlistItems
  ) {
    destination_wishlist {
      ...WishlistFragment
    }
    source_wishlist {
      ...WishlistFragment
    }
    user_errors {
      ...WishListUserInputErrorFragment
    }
  }
}
Variables
Copied to your clipboard
{
  "sourceWishlistUid": "4",
  "destinationWishlistUid": "4",
  "wishlistItems": [WishlistItemCopyInput]
}
Response
Copied to your clipboard
{
  "data": {
    "copyProductsBetweenWishlists": {
      "destination_wishlist": Wishlist,
      "source_wishlist": Wishlist,
      "user_errors": [WishListUserInputError]
    }
  }
}

createBraintreeClientToken

Creates Client Token for Braintree Javascript SDK initialization.

Response: String!

Example

Query
Copied to your clipboard
mutation createBraintreeClientToken {
  createBraintreeClientToken
}
Response
Copied to your clipboard
{
  "data": {
    "createBraintreeClientToken": "xyz789"
  }
}

createBraintreePayPalClientToken

Creates Client Token for Braintree PayPal Javascript SDK initialization.

Response: String!

Example

Query
Copied to your clipboard
mutation createBraintreePayPalClientToken {
  createBraintreePayPalClientToken
}
Response
Copied to your clipboard
{
  "data": {
    "createBraintreePayPalClientToken": "abc123"
  }
}

createBraintreePayPalVaultClientToken

Creates Client Token for Braintree PayPal Vault Javascript SDK initialization.

Response: String!

Arguments

NameDescription
input - BraintreeVaultInput

Example

Query
Copied to your clipboard
mutation createBraintreePayPalVaultClientToken($input: BraintreeVaultInput) {
  createBraintreePayPalVaultClientToken(input: $input)
}
Variables
Copied to your clipboard
{"input": BraintreeVaultInput}
Response
Copied to your clipboard
{
  "data": {
    "createBraintreePayPalVaultClientToken": "abc123"
  }
}

createCompany

Create a company at the request of either a customer or a guest.

Response: CreateCompanyOutput

Arguments

NameDescription
input - CompanyCreateInput!

Example

Query
Copied to your clipboard
mutation createCompany($input: CompanyCreateInput!) {
  createCompany(input: $input) {
    company {
      ...CompanyFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": CompanyCreateInput}
Response
Copied to your clipboard
{"data": {"createCompany": {"company": Company}}}

createCompanyRole

Create a new company role.

Response: CreateCompanyRoleOutput

Arguments

NameDescription
input - CompanyRoleCreateInput!

Example

Query
Copied to your clipboard
mutation createCompanyRole($input: CompanyRoleCreateInput!) {
  createCompanyRole(input: $input) {
    role {
      ...CompanyRoleFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": CompanyRoleCreateInput}
Response
Copied to your clipboard
{"data": {"createCompanyRole": {"role": CompanyRole}}}

createCompanyTeam

Create a new team for the customer's company within the current company context.

Response: CreateCompanyTeamOutput

Arguments

NameDescription
input - CompanyTeamCreateInput!

Example

Query
Copied to your clipboard
mutation createCompanyTeam($input: CompanyTeamCreateInput!) {
  createCompanyTeam(input: $input) {
    team {
      ...CompanyTeamFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": CompanyTeamCreateInput}
Response
Copied to your clipboard
{"data": {"createCompanyTeam": {"team": CompanyTeam}}}

createCompanyUser

Create a new company user at the request of an existing customer.

Response: CreateCompanyUserOutput

Arguments

NameDescription
input - CompanyUserCreateInput!

Example

Query
Copied to your clipboard
mutation createCompanyUser($input: CompanyUserCreateInput!) {
  createCompanyUser(input: $input) {
    user {
      ...CustomerFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": CompanyUserCreateInput}
Response
Copied to your clipboard
{"data": {"createCompanyUser": {"user": Customer}}}

createCompareList

Create a new compare list. The compare list is saved for logged in customers.

Response: CompareList

Arguments

NameDescription
input - CreateCompareListInput

Example

Query
Copied to your clipboard
mutation createCompareList($input: CreateCompareListInput) {
  createCompareList(input: $input) {
    attributes {
      ...ComparableAttributeFragment
    }
    item_count
    items {
      ...ComparableItemFragment
    }
    uid
  }
}
Variables
Copied to your clipboard
{"input": CreateCompareListInput}
Response
Copied to your clipboard
{
  "data": {
    "createCompareList": {
      "attributes": [ComparableAttribute],
      "item_count": 987,
      "items": [ComparableItem],
      "uid": 4
    }
  }
}

createCustomer

Deprecated

Use createCustomerV2 instead.

Response: CustomerOutput

Arguments

NameDescription
input - CustomerInput!
An input object that defines the customer to be created.

Example

Query
Copied to your clipboard
mutation createCustomer($input: CustomerInput!) {
  createCustomer(input: $input) {
    customer {
      ...CustomerFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": CustomerInput}
Response
Copied to your clipboard
{"data": {"createCustomer": {"customer": Customer}}}

createCustomerAddress

Create a billing or shipping address for a customer or guest.

Response: CustomerAddress

Arguments

NameDescription
input - CustomerAddressInput!

Example

Query
Copied to your clipboard
mutation createCustomerAddress($input: CustomerAddressInput!) {
  createCustomerAddress(input: $input) {
    city
    company
    country_code
    country_id
    custom_attributes {
      ...CustomerAddressAttributeFragment
    }
    custom_attributesV2 {
      ...AttributeValueInterfaceFragment
    }
    customer_id
    default_billing
    default_shipping
    extension_attributes {
      ...CustomerAddressAttributeFragment
    }
    fax
    firstname
    id
    lastname
    middlename
    postcode
    prefix
    region {
      ...CustomerAddressRegionFragment
    }
    region_id
    street
    suffix
    telephone
    uid
    vat_id
  }
}
Variables
Copied to your clipboard
{"input": CustomerAddressInput}
Response
Copied to your clipboard
{
  "data": {
    "createCustomerAddress": {
      "city": "xyz789",
      "company": "abc123",
      "country_code": "AF",
      "country_id": "xyz789",
      "custom_attributes": [CustomerAddressAttribute],
      "custom_attributesV2": [AttributeValueInterface],
      "customer_id": 987,
      "default_billing": true,
      "default_shipping": false,
      "extension_attributes": [CustomerAddressAttribute],
      "fax": "abc123",
      "firstname": "abc123",
      "id": 987,
      "lastname": "abc123",
      "middlename": "abc123",
      "postcode": "abc123",
      "prefix": "abc123",
      "region": CustomerAddressRegion,
      "region_id": 123,
      "street": ["abc123"],
      "suffix": "abc123",
      "telephone": "xyz789",
      "uid": 4,
      "vat_id": "abc123"
    }
  }
}

createCustomerV2

Create a customer account.

Response: CustomerOutput

Arguments

NameDescription
input - CustomerCreateInput!
An input object that defines the customer to be created.

Example

Query
Copied to your clipboard
mutation createCustomerV2($input: CustomerCreateInput!) {
  createCustomerV2(input: $input) {
    customer {
      ...CustomerFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": CustomerCreateInput}
Response
Copied to your clipboard
{"data": {"createCustomerV2": {"customer": Customer}}}

createEmptyCart

Deprecated

Use Mutation.createGuestCart or Query.customerCart for logged in customer

Create an empty shopping cart for a guest or logged in user

Response: String

Arguments

NameDescription
input - createEmptyCartInput
An optional input object that assigns the specified ID to the cart.

Example

Query
Copied to your clipboard
mutation createEmptyCart($input: createEmptyCartInput) {
  createEmptyCart(input: $input)
}
Variables
Copied to your clipboard
{"input": createEmptyCartInput}
Response
Copied to your clipboard
{"data": {"createEmptyCart": "xyz789"}}

createGiftRegistry

Create a gift registry on behalf of the customer.

Response: CreateGiftRegistryOutput

Arguments

NameDescription
giftRegistry - CreateGiftRegistryInput!
An input object that defines a new gift registry.

Example

Query
Copied to your clipboard
mutation createGiftRegistry($giftRegistry: CreateGiftRegistryInput!) {
  createGiftRegistry(giftRegistry: $giftRegistry) {
    gift_registry {
      ...GiftRegistryFragment
    }
  }
}
Variables
Copied to your clipboard
{"giftRegistry": CreateGiftRegistryInput}
Response
Copied to your clipboard
{
  "data": {
    "createGiftRegistry": {"gift_registry": GiftRegistry}
  }
}

createGuestCart

Create a new shopping cart

Response: CreateGuestCartOutput

Arguments

NameDescription
input - CreateGuestCartInput

Example

Query
Copied to your clipboard
mutation createGuestCart($input: CreateGuestCartInput) {
  createGuestCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": CreateGuestCartInput}
Response
Copied to your clipboard
{"data": {"createGuestCart": {"cart": Cart}}}

createPayflowProToken

Initiate a transaction and receive a token. Use this mutation for Payflow Pro and Payments Pro payment methods

Response: CreatePayflowProTokenOutput

Arguments

NameDescription
input - PayflowProTokenInput!
An input object that defines the requirements to fetch payment token information.

Example

Query
Copied to your clipboard
mutation createPayflowProToken($input: PayflowProTokenInput!) {
  createPayflowProToken(input: $input) {
    response_message
    result
    result_code
    secure_token
    secure_token_id
  }
}
Variables
Copied to your clipboard
{"input": PayflowProTokenInput}
Response
Copied to your clipboard
{
  "data": {
    "createPayflowProToken": {
      "response_message": "abc123",
      "result": 123,
      "result_code": 987,
      "secure_token": "xyz789",
      "secure_token_id": "abc123"
    }
  }
}

createPaymentOrder

Creates a payment order for further payment processing

Response: CreatePaymentOrderOutput

Arguments

NameDescription
input - CreatePaymentOrderInput!
Contains payment order details that are used while processing the payment order

Example

Query
Copied to your clipboard
mutation createPaymentOrder($input: CreatePaymentOrderInput!) {
  createPaymentOrder(input: $input) {
    amount
    currency_code
    id
    mp_order_id
    status
  }
}
Variables
Copied to your clipboard
{"input": CreatePaymentOrderInput}
Response
Copied to your clipboard
{
  "data": {
    "createPaymentOrder": {
      "amount": 987.65,
      "currency_code": "abc123",
      "id": "xyz789",
      "mp_order_id": "xyz789",
      "status": "xyz789"
    }
  }
}

createPaypalExpressToken

Initiate an Express Checkout transaction and receive a token. Use this mutation for Express Checkout and Payments Standard payment methods.

Response: PaypalExpressTokenOutput

Arguments

NameDescription
input - PaypalExpressTokenInput!
An input object that defines the requirements to receive a payment token.

Example

Query
Copied to your clipboard
mutation createPaypalExpressToken($input: PaypalExpressTokenInput!) {
  createPaypalExpressToken(input: $input) {
    paypal_urls {
      ...PaypalExpressUrlListFragment
    }
    token
  }
}
Variables
Copied to your clipboard
{"input": PaypalExpressTokenInput}
Response
Copied to your clipboard
{
  "data": {
    "createPaypalExpressToken": {
      "paypal_urls": PaypalExpressUrlList,
      "token": "abc123"
    }
  }
}

createProductReview

Create a product review for the specified product.

Response: CreateProductReviewOutput!

Arguments

NameDescription
input - CreateProductReviewInput!
An input object that contains the details necessary to create a product review.

Example

Query
Copied to your clipboard
mutation createProductReview($input: CreateProductReviewInput!) {
  createProductReview(input: $input) {
    review {
      ...ProductReviewFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": CreateProductReviewInput}
Response
Copied to your clipboard
{
  "data": {
    "createProductReview": {"review": ProductReview}
  }
}

createPurchaseOrderApprovalRule

Create a purchase order approval rule.

Response: PurchaseOrderApprovalRule

Arguments

NameDescription
input - PurchaseOrderApprovalRuleInput!

Example

Query
Copied to your clipboard
mutation createPurchaseOrderApprovalRule($input: PurchaseOrderApprovalRuleInput!) {
  createPurchaseOrderApprovalRule(input: $input) {
    applies_to_roles {
      ...CompanyRoleFragment
    }
    approver_roles {
      ...CompanyRoleFragment
    }
    condition {
      ...PurchaseOrderApprovalRuleConditionInterfaceFragment
    }
    created_at
    created_by
    description
    name
    status
    uid
    updated_at
  }
}
Variables
Copied to your clipboard
{"input": PurchaseOrderApprovalRuleInput}
Response
Copied to your clipboard
{
  "data": {
    "createPurchaseOrderApprovalRule": {
      "applies_to_roles": [CompanyRole],
      "approver_roles": [CompanyRole],
      "condition": PurchaseOrderApprovalRuleConditionInterface,
      "created_at": "abc123",
      "created_by": "xyz789",
      "description": "xyz789",
      "name": "abc123",
      "status": "ENABLED",
      "uid": 4,
      "updated_at": "abc123"
    }
  }
}

createRequisitionList

Create an empty requisition list.

Response: CreateRequisitionListOutput

Arguments

NameDescription
input - CreateRequisitionListInput

Example

Query
Copied to your clipboard
mutation createRequisitionList($input: CreateRequisitionListInput) {
  createRequisitionList(input: $input) {
    requisition_list {
      ...RequisitionListFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": CreateRequisitionListInput}
Response
Copied to your clipboard
{
  "data": {
    "createRequisitionList": {
      "requisition_list": RequisitionList
    }
  }
}

createVaultCardPaymentToken

Creates a vault payment token

Response: CreateVaultCardPaymentTokenOutput

Arguments

NameDescription
input - CreateVaultCardPaymentTokenInput!
Describe the variables needed to create a vault card payment token

Example

Query
Copied to your clipboard
mutation createVaultCardPaymentToken($input: CreateVaultCardPaymentTokenInput!) {
  createVaultCardPaymentToken(input: $input) {
    payment_source {
      ...PaymentSourceOutputFragment
    }
    vault_token_id
  }
}
Variables
Copied to your clipboard
{"input": CreateVaultCardPaymentTokenInput}
Response
Copied to your clipboard
{
  "data": {
    "createVaultCardPaymentToken": {
      "payment_source": PaymentSourceOutput,
      "vault_token_id": "abc123"
    }
  }
}

createVaultCardSetupToken

Creates a vault card setup token

Response: CreateVaultCardSetupTokenOutput

Arguments

NameDescription
input - CreateVaultCardSetupTokenInput!
Describe the variables needed to create a vault card setup token

Example

Query
Copied to your clipboard
mutation createVaultCardSetupToken($input: CreateVaultCardSetupTokenInput!) {
  createVaultCardSetupToken(input: $input) {
    setup_token
  }
}
Variables
Copied to your clipboard
{"input": CreateVaultCardSetupTokenInput}
Response
Copied to your clipboard
{
  "data": {
    "createVaultCardSetupToken": {
      "setup_token": "abc123"
    }
  }
}

createWishlist

Create a new wish list.

Response: CreateWishlistOutput

Arguments

NameDescription
input - CreateWishlistInput!
An input object that defines a new wish list.

Example

Query
Copied to your clipboard
mutation createWishlist($input: CreateWishlistInput!) {
  createWishlist(input: $input) {
    wishlist {
      ...WishlistFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": CreateWishlistInput}
Response
Copied to your clipboard
{"data": {"createWishlist": {"wishlist": Wishlist}}}

deleteCompanyRole

Delete the specified company role.

Response: DeleteCompanyRoleOutput

Arguments

NameDescription
id - ID!

Example

Query
Copied to your clipboard
mutation deleteCompanyRole($id: ID!) {
  deleteCompanyRole(id: $id) {
    success
  }
}
Variables
Copied to your clipboard
{"id": "4"}
Response
Copied to your clipboard
{"data": {"deleteCompanyRole": {"success": false}}}

deleteCompanyTeam

Delete the specified company team.

Response: DeleteCompanyTeamOutput

Arguments

NameDescription
id - ID!

Example

Query
Copied to your clipboard
mutation deleteCompanyTeam($id: ID!) {
  deleteCompanyTeam(id: $id) {
    success
  }
}
Variables
Copied to your clipboard
{"id": "4"}
Response
Copied to your clipboard
{"data": {"deleteCompanyTeam": {"success": false}}}

deleteCompanyUser

Deprecated

Use deleteCompanyUserV2 instead. The current method only deactivates the user account associated with the company.

Delete the specified company user.

Response: DeleteCompanyUserOutput

Arguments

NameDescription
id - ID!

Example

Query
Copied to your clipboard
mutation deleteCompanyUser($id: ID!) {
  deleteCompanyUser(id: $id) {
    success
  }
}
Variables
Copied to your clipboard
{"id": 4}
Response
Copied to your clipboard
{"data": {"deleteCompanyUser": {"success": false}}}

deleteCompanyUserV2

Delete the specified company user.

Response: DeleteCompanyUserOutput

Arguments

NameDescription
id - ID!

Example

Query
Copied to your clipboard
mutation deleteCompanyUserV2($id: ID!) {
  deleteCompanyUserV2(id: $id) {
    success
  }
}
Variables
Copied to your clipboard
{"id": "4"}
Response
Copied to your clipboard
{"data": {"deleteCompanyUserV2": {"success": true}}}

deleteCompareList

Delete the specified compare list.

Response: DeleteCompareListOutput

Arguments

NameDescription
uid - ID!
The unique ID of the compare list to be deleted.

Example

Query
Copied to your clipboard
mutation deleteCompareList($uid: ID!) {
  deleteCompareList(uid: $uid) {
    result
  }
}
Variables
Copied to your clipboard
{"uid": 4}
Response
Copied to your clipboard
{"data": {"deleteCompareList": {"result": false}}}

deleteCustomer

Delete customer account

Response: Boolean

Example

Query
Copied to your clipboard
mutation deleteCustomer {
  deleteCustomer
}
Response
Copied to your clipboard
{"data": {"deleteCustomer": true}}

deleteCustomerAddress

Deprecated

Use deleteCustomerAddressV2 instead.

Delete the billing or shipping address of a customer.

Response: Boolean

Arguments

NameDescription
id - Int!
The ID of the customer address to be deleted.

Example

Query
Copied to your clipboard
mutation deleteCustomerAddress($id: Int!) {
  deleteCustomerAddress(id: $id)
}
Variables
Copied to your clipboard
{"id": 987}
Response
Copied to your clipboard
{"data": {"deleteCustomerAddress": false}}

deleteCustomerAddressV2

Delete the billing or shipping address of a customer.

Response: Boolean

Arguments

NameDescription
uid - ID!
The unique ID of the customer address to be deleted.

Example

Query
Copied to your clipboard
mutation deleteCustomerAddressV2($uid: ID!) {
  deleteCustomerAddressV2(uid: $uid)
}
Variables
Copied to your clipboard
{"uid": "4"}
Response
Copied to your clipboard
{"data": {"deleteCustomerAddressV2": true}}

deleteNegotiableQuoteTemplate

Delete a negotiable quote template

Response: Boolean!

Arguments

NameDescription
input - DeleteNegotiableQuoteTemplateInput!
An input object that cancels a negotiable quote template.

Example

Query
Copied to your clipboard
mutation deleteNegotiableQuoteTemplate($input: DeleteNegotiableQuoteTemplateInput!) {
  deleteNegotiableQuoteTemplate(input: $input)
}
Variables
Copied to your clipboard
{"input": DeleteNegotiableQuoteTemplateInput}
Response
Copied to your clipboard
{"data": {"deleteNegotiableQuoteTemplate": false}}

deleteNegotiableQuotes

Delete a negotiable quote. The negotiable quote will not be displayed on the storefront.

Response: DeleteNegotiableQuotesOutput

Arguments

NameDescription
input - DeleteNegotiableQuotesInput!
An input object that deletes a negotiable quote.

Example

Query
Copied to your clipboard
mutation deleteNegotiableQuotes($input: DeleteNegotiableQuotesInput!) {
  deleteNegotiableQuotes(input: $input) {
    negotiable_quotes {
      ...NegotiableQuotesOutputFragment
    }
    operation_results {
      ... on NegotiableQuoteUidOperationSuccess {
        ...NegotiableQuoteUidOperationSuccessFragment
      }
      ... on DeleteNegotiableQuoteOperationFailure {
        ...DeleteNegotiableQuoteOperationFailureFragment
      }
    }
    result_status
  }
}
Variables
Copied to your clipboard
{"input": DeleteNegotiableQuotesInput}
Response
Copied to your clipboard
{
  "data": {
    "deleteNegotiableQuotes": {
      "negotiable_quotes": NegotiableQuotesOutput,
      "operation_results": [
        NegotiableQuoteUidOperationSuccess
      ],
      "result_status": "SUCCESS"
    }
  }
}

deletePaymentToken

Delete a customer's payment token.

Response: DeletePaymentTokenOutput

Arguments

NameDescription
public_hash - String!
The reusable payment token securely stored in the vault.

Example

Query
Copied to your clipboard
mutation deletePaymentToken($public_hash: String!) {
  deletePaymentToken(public_hash: $public_hash) {
    customerPaymentTokens {
      ...CustomerPaymentTokensFragment
    }
    result
  }
}
Variables
Copied to your clipboard
{"public_hash": "abc123"}
Response
Copied to your clipboard
{
  "data": {
    "deletePaymentToken": {
      "customerPaymentTokens": CustomerPaymentTokens,
      "result": false
    }
  }
}

deletePurchaseOrderApprovalRule

Delete existing purchase order approval rules.

Response: DeletePurchaseOrderApprovalRuleOutput

Arguments

NameDescription
input - DeletePurchaseOrderApprovalRuleInput!

Example

Query
Copied to your clipboard
mutation deletePurchaseOrderApprovalRule($input: DeletePurchaseOrderApprovalRuleInput!) {
  deletePurchaseOrderApprovalRule(input: $input) {
    errors {
      ...DeletePurchaseOrderApprovalRuleErrorFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": DeletePurchaseOrderApprovalRuleInput}
Response
Copied to your clipboard
{
  "data": {
    "deletePurchaseOrderApprovalRule": {
      "errors": [DeletePurchaseOrderApprovalRuleError]
    }
  }
}

deleteRequisitionList

Delete a requisition list.

Response: DeleteRequisitionListOutput

Arguments

NameDescription
requisitionListUid - ID!
The unique ID of the requisition list.

Example

Query
Copied to your clipboard
mutation deleteRequisitionList($requisitionListUid: ID!) {
  deleteRequisitionList(requisitionListUid: $requisitionListUid) {
    requisition_lists {
      ...RequisitionListsFragment
    }
    status
  }
}
Variables
Copied to your clipboard
{"requisitionListUid": 4}
Response
Copied to your clipboard
{
  "data": {
    "deleteRequisitionList": {
      "requisition_lists": RequisitionLists,
      "status": true
    }
  }
}

deleteRequisitionListItems

Delete items from a requisition list.

Response: DeleteRequisitionListItemsOutput

Arguments

NameDescription
requisitionListUid - ID!
The unique ID of the requisition list.
requisitionListItemUids - [ID!]!
An array of UIDs representing products to be removed from the requisition list.

Example

Query
Copied to your clipboard
mutation deleteRequisitionListItems(
  $requisitionListUid: ID!,
  $requisitionListItemUids: [ID!]!
) {
  deleteRequisitionListItems(
    requisitionListUid: $requisitionListUid,
    requisitionListItemUids: $requisitionListItemUids
  ) {
    requisition_list {
      ...RequisitionListFragment
    }
  }
}
Variables
Copied to your clipboard
{"requisitionListUid": 4, "requisitionListItemUids": [4]}
Response
Copied to your clipboard
{
  "data": {
    "deleteRequisitionListItems": {
      "requisition_list": RequisitionList
    }
  }
}

deleteWishlist

Delete the specified wish list. You cannot delete the customer's default (first) wish list.

Response: DeleteWishlistOutput

Arguments

NameDescription
wishlistId - ID!
The ID of the wish list to delete.

Example

Query
Copied to your clipboard
mutation deleteWishlist($wishlistId: ID!) {
  deleteWishlist(wishlistId: $wishlistId) {
    status
    wishlists {
      ...WishlistFragment
    }
  }
}
Variables
Copied to your clipboard
{"wishlistId": "4"}
Response
Copied to your clipboard
{
  "data": {
    "deleteWishlist": {
      "status": false,
      "wishlists": [Wishlist]
    }
  }
}

duplicateNegotiableQuote

Negotiable Quote resulting from duplication operation.

Response: DuplicateNegotiableQuoteOutput

Arguments

NameDescription
input - DuplicateNegotiableQuoteInput!
An input object that defines ID of the quote to be duplicated.

Example

Query
Copied to your clipboard
mutation duplicateNegotiableQuote($input: DuplicateNegotiableQuoteInput!) {
  duplicateNegotiableQuote(input: $input) {
    quote {
      ...NegotiableQuoteFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": DuplicateNegotiableQuoteInput}
Response
Copied to your clipboard
{
  "data": {
    "duplicateNegotiableQuote": {"quote": NegotiableQuote}
  }
}

estimateShippingMethods

Estimate shipping method(s) for cart based on address

Response: [AvailableShippingMethod]

Arguments

NameDescription
input - EstimateTotalsInput!
An input object that specifies details for estimation of available shipping methods

Example

Query
Copied to your clipboard
mutation estimateShippingMethods($input: EstimateTotalsInput!) {
  estimateShippingMethods(input: $input) {
    amount {
      ...MoneyFragment
    }
    available
    base_amount {
      ...MoneyFragment
    }
    carrier_code
    carrier_title
    error_message
    method_code
    method_title
    price_excl_tax {
      ...MoneyFragment
    }
    price_incl_tax {
      ...MoneyFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": EstimateTotalsInput}
Response
Copied to your clipboard
{
  "data": {
    "estimateShippingMethods": [
      {
        "amount": Money,
        "available": false,
        "base_amount": Money,
        "carrier_code": "xyz789",
        "carrier_title": "abc123",
        "error_message": "abc123",
        "method_code": "xyz789",
        "method_title": "abc123",
        "price_excl_tax": Money,
        "price_incl_tax": Money
      }
    ]
  }
}

estimateTotals

Estimate totals for cart based on the address

Response: EstimateTotalsOutput!

Arguments

NameDescription
input - EstimateTotalsInput!
An input object that specifies details for cart totals estimation

Example

Query
Copied to your clipboard
mutation estimateTotals($input: EstimateTotalsInput!) {
  estimateTotals(input: $input) {
    cart {
      ...CartFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": EstimateTotalsInput}
Response
Copied to your clipboard
{"data": {"estimateTotals": {"cart": Cart}}}

exchangeExternalCustomerToken

Generate a token for specified customer.

Response: ExchangeExternalCustomerTokenOutput

Arguments

NameDescription
input - ExchangeExternalCustomerTokenInput
Contains details about external customer.

Example

Query
Copied to your clipboard
mutation exchangeExternalCustomerToken($input: ExchangeExternalCustomerTokenInput) {
  exchangeExternalCustomerToken(input: $input) {
    customer {
      ...CustomerFragment
    }
    token
  }
}
Variables
Copied to your clipboard
{"input": ExchangeExternalCustomerTokenInput}
Response
Copied to your clipboard
{
  "data": {
    "exchangeExternalCustomerToken": {
      "customer": Customer,
      "token": "abc123"
    }
  }
}

generateCustomerToken

Generate a token for specified customer.

Response: CustomerToken

Arguments

NameDescription
email - String!
The customer's email address.
password - String!
The customer's password.

Example

Query
Copied to your clipboard
mutation generateCustomerToken(
  $email: String!,
  $password: String!
) {
  generateCustomerToken(
    email: $email,
    password: $password
  ) {
    token
  }
}
Variables
Copied to your clipboard
{
  "email": "abc123",
  "password": "abc123"
}
Response
Copied to your clipboard
{
  "data": {
    "generateCustomerToken": {
      "token": "xyz789"
    }
  }
}

generateCustomerTokenAsAdmin

Request a customer token so that an administrator can perform remote shopping assistance.

Response: GenerateCustomerTokenAsAdminOutput

Arguments

NameDescription
input - GenerateCustomerTokenAsAdminInput!
An input object that defines the customer email address.

Example

Query
Copied to your clipboard
mutation generateCustomerTokenAsAdmin($input: GenerateCustomerTokenAsAdminInput!) {
  generateCustomerTokenAsAdmin(input: $input) {
    customer_token
  }
}
Variables
Copied to your clipboard
{"input": GenerateCustomerTokenAsAdminInput}
Response
Copied to your clipboard
{
  "data": {
    "generateCustomerTokenAsAdmin": {
      "customer_token": "abc123"
    }
  }
}

generateNegotiableQuoteFromTemplate

Generate a negotiable quote from an accept quote template.

Response: GenerateNegotiableQuoteFromTemplateOutput

Arguments

NameDescription
input - GenerateNegotiableQuoteFromTemplateInput!
An input object that contains the data to generate a negotiable quote from quote template.

Example

Query
Copied to your clipboard
mutation generateNegotiableQuoteFromTemplate($input: GenerateNegotiableQuoteFromTemplateInput!) {
  generateNegotiableQuoteFromTemplate(input: $input) {
    negotiable_quote_uid
  }
}
Variables
Copied to your clipboard
{"input": GenerateNegotiableQuoteFromTemplateInput}
Response
Copied to your clipboard
{
  "data": {
    "generateNegotiableQuoteFromTemplate": {
      "negotiable_quote_uid": "4"
    }
  }
}

handlePayflowProResponse

Handle a payment response and save the payment in Quote. Use this mutation for Payflow Pro and Payments Pro payment methods.

Response: PayflowProResponseOutput

Arguments

NameDescription
input - PayflowProResponseInput!
An input object that includes the payload returned by PayPal and the cart ID.

Example

Query
Copied to your clipboard
mutation handlePayflowProResponse($input: PayflowProResponseInput!) {
  handlePayflowProResponse(input: $input) {
    cart {
      ...CartFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": PayflowProResponseInput}
Response
Copied to your clipboard
{"data": {"handlePayflowProResponse": {"cart": Cart}}}

mergeCarts

Transfer the contents of a guest cart into the cart of a logged-in customer.

Response: Cart!

Arguments

NameDescription
source_cart_id - String!
The guest's cart ID before they login.
destination_cart_id - String
The cart ID after the guest logs in.

Example

Query
Copied to your clipboard
mutation mergeCarts(
  $source_cart_id: String!,
  $destination_cart_id: String
) {
  mergeCarts(
    source_cart_id: $source_cart_id,
    destination_cart_id: $destination_cart_id
  ) {
    applied_coupon {
      ...AppliedCouponFragment
    }
    applied_coupons {
      ...AppliedCouponFragment
    }
    applied_gift_cards {
      ...AppliedGiftCardFragment
    }
    applied_reward_points {
      ...RewardPointsAmountFragment
    }
    applied_store_credit {
      ...AppliedStoreCreditFragment
    }
    available_gift_wrappings {
      ...GiftWrappingFragment
    }
    available_payment_methods {
      ...AvailablePaymentMethodFragment
    }
    billing_address {
      ...BillingCartAddressFragment
    }
    email
    gift_message {
      ...GiftMessageFragment
    }
    gift_receipt_included
    gift_wrapping {
      ...GiftWrappingFragment
    }
    id
    is_virtual
    items {
      ...CartItemInterfaceFragment
    }
    itemsV2 {
      ...CartItemsFragment
    }
    prices {
      ...CartPricesFragment
    }
    printed_card_included
    rules {
      ...CartRuleStorefrontFragment
    }
    selected_payment_method {
      ...SelectedPaymentMethodFragment
    }
    shipping_addresses {
      ...ShippingCartAddressFragment
    }
    total_quantity
  }
}
Variables
Copied to your clipboard
{
  "source_cart_id": "xyz789",
  "destination_cart_id": "abc123"
}
Response
Copied to your clipboard
{
  "data": {
    "mergeCarts": {
      "applied_coupon": AppliedCoupon,
      "applied_coupons": [AppliedCoupon],
      "applied_gift_cards": [AppliedGiftCard],
      "applied_reward_points": RewardPointsAmount,
      "applied_store_credit": AppliedStoreCredit,
      "available_gift_wrappings": [GiftWrapping],
      "available_payment_methods": [
        AvailablePaymentMethod
      ],
      "billing_address": BillingCartAddress,
      "email": "abc123",
      "gift_message": GiftMessage,
      "gift_receipt_included": true,
      "gift_wrapping": GiftWrapping,
      "id": 4,
      "is_virtual": true,
      "items": [CartItemInterface],
      "itemsV2": CartItems,
      "prices": CartPrices,
      "printed_card_included": true,
      "rules": [CartRuleStorefront],
      "selected_payment_method": SelectedPaymentMethod,
      "shipping_addresses": [ShippingCartAddress],
      "total_quantity": 123.45
    }
  }
}

moveCartItemsToGiftRegistry

Move all items from the cart to a gift registry.

Response: MoveCartItemsToGiftRegistryOutput

Arguments

NameDescription
cartUid - ID!
The unique ID of the cart containing items to be moved to a gift registry.
giftRegistryUid - ID!
The unique ID of the target gift registry.

Example

Query
Copied to your clipboard
mutation moveCartItemsToGiftRegistry(
  $cartUid: ID!,
  $giftRegistryUid: ID!
) {
  moveCartItemsToGiftRegistry(
    cartUid: $cartUid,
    giftRegistryUid: $giftRegistryUid
  ) {
    gift_registry {
      ...GiftRegistryFragment
    }
    status
    user_errors {
      ...GiftRegistryItemsUserErrorFragment
    }
  }
}
Variables
Copied to your clipboard
{"cartUid": 4, "giftRegistryUid": "4"}
Response
Copied to your clipboard
{
  "data": {
    "moveCartItemsToGiftRegistry": {
      "gift_registry": GiftRegistry,
      "status": true,
      "user_errors": [GiftRegistryItemsUserError]
    }
  }
}

moveItemsBetweenRequisitionLists

Move Items from one requisition list to another.

Response: MoveItemsBetweenRequisitionListsOutput

Arguments

NameDescription
sourceRequisitionListUid - ID!
The unique ID of the source requisition list.
destinationRequisitionListUid - ID
The unique ID of the destination requisition list. If null, a new requisition list will be created.
requisitionListItem - MoveItemsBetweenRequisitionListsInput
The list of products to move.

Example

Query
Copied to your clipboard
mutation moveItemsBetweenRequisitionLists(
  $sourceRequisitionListUid: ID!,
  $destinationRequisitionListUid: ID,
  $requisitionListItem: MoveItemsBetweenRequisitionListsInput
) {
  moveItemsBetweenRequisitionLists(
    sourceRequisitionListUid: $sourceRequisitionListUid,
    destinationRequisitionListUid: $destinationRequisitionListUid,
    requisitionListItem: $requisitionListItem
  ) {
    destination_requisition_list {
      ...RequisitionListFragment
    }
    source_requisition_list {
      ...RequisitionListFragment
    }
  }
}
Variables
Copied to your clipboard
{
  "sourceRequisitionListUid": "4",
  "destinationRequisitionListUid": 4,
  "requisitionListItem": MoveItemsBetweenRequisitionListsInput
}
Response
Copied to your clipboard
{
  "data": {
    "moveItemsBetweenRequisitionLists": {
      "destination_requisition_list": RequisitionList,
      "source_requisition_list": RequisitionList
    }
  }
}

moveLineItemToRequisitionList

Move negotiable quote item to requisition list.

Response: MoveLineItemToRequisitionListOutput

Arguments

NameDescription
input - MoveLineItemToRequisitionListInput!
An input object that defines the quote item and requisition list moved to.

Example

Query
Copied to your clipboard
mutation moveLineItemToRequisitionList($input: MoveLineItemToRequisitionListInput!) {
  moveLineItemToRequisitionList(input: $input) {
    quote {
      ...NegotiableQuoteFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": MoveLineItemToRequisitionListInput}
Response
Copied to your clipboard
{
  "data": {
    "moveLineItemToRequisitionList": {
      "quote": NegotiableQuote
    }
  }
}

moveProductsBetweenWishlists

Move products from one wish list to another.

Response: MoveProductsBetweenWishlistsOutput

Arguments

NameDescription
sourceWishlistUid - ID!
The ID of the original wish list.
destinationWishlistUid - ID!
The ID of the target wish list.
wishlistItems - [WishlistItemMoveInput!]!
An array of items to move.

Example

Query
Copied to your clipboard
mutation moveProductsBetweenWishlists(
  $sourceWishlistUid: ID!,
  $destinationWishlistUid: ID!,
  $wishlistItems: [WishlistItemMoveInput!]!
) {
  moveProductsBetweenWishlists(
    sourceWishlistUid: $sourceWishlistUid,
    destinationWishlistUid: $destinationWishlistUid,
    wishlistItems: $wishlistItems
  ) {
    destination_wishlist {
      ...WishlistFragment
    }
    source_wishlist {
      ...WishlistFragment
    }
    user_errors {
      ...WishListUserInputErrorFragment
    }
  }
}
Variables
Copied to your clipboard
{
  "sourceWishlistUid": "4",
  "destinationWishlistUid": 4,
  "wishlistItems": [WishlistItemMoveInput]
}
Response
Copied to your clipboard
{
  "data": {
    "moveProductsBetweenWishlists": {
      "destination_wishlist": Wishlist,
      "source_wishlist": Wishlist,
      "user_errors": [WishListUserInputError]
    }
  }
}

openNegotiableQuoteTemplate

Open an existing negotiable quote template.

Response: NegotiableQuoteTemplate

Arguments

NameDescription
input - OpenNegotiableQuoteTemplateInput!
An input object that contains the data to open a negotiable quote template.

Example

Query
Copied to your clipboard
mutation openNegotiableQuoteTemplate($input: OpenNegotiableQuoteTemplateInput!) {
  openNegotiableQuoteTemplate(input: $input) {
    buyer {
      ...NegotiableQuoteUserFragment
    }
    comments {
      ...NegotiableQuoteCommentFragment
    }
    expiration_date
    history {
      ...NegotiableQuoteHistoryEntryFragment
    }
    is_min_max_qty_used
    is_virtual
    items {
      ...CartItemInterfaceFragment
    }
    max_order_commitment
    min_order_commitment
    name
    notifications {
      ...QuoteTemplateNotificationMessageFragment
    }
    prices {
      ...CartPricesFragment
    }
    reference_document_links {
      ...NegotiableQuoteReferenceDocumentLinkFragment
    }
    shipping_addresses {
      ...NegotiableQuoteShippingAddressFragment
    }
    status
    template_id
    total_quantity
  }
}
Variables
Copied to your clipboard
{"input": OpenNegotiableQuoteTemplateInput}
Response
Copied to your clipboard
{
  "data": {
    "openNegotiableQuoteTemplate": {
      "buyer": NegotiableQuoteUser,
      "comments": [NegotiableQuoteComment],
      "expiration_date": "xyz789",
      "history": [NegotiableQuoteHistoryEntry],
      "is_min_max_qty_used": false,
      "is_virtual": false,
      "items": [CartItemInterface],
      "max_order_commitment": 987,
      "min_order_commitment": 123,
      "name": "abc123",
      "notifications": [QuoteTemplateNotificationMessage],
      "prices": CartPrices,
      "reference_document_links": [
        NegotiableQuoteReferenceDocumentLink
      ],
      "shipping_addresses": [
        NegotiableQuoteShippingAddress
      ],
      "status": "abc123",
      "template_id": 4,
      "total_quantity": 123.45
    }
  }
}

placeNegotiableQuoteOrder

Convert a negotiable quote into an order.

Response: PlaceNegotiableQuoteOrderOutput

Arguments

NameDescription
input - PlaceNegotiableQuoteOrderInput!
An input object that specifies the negotiable quote.

Example

Query
Copied to your clipboard
mutation placeNegotiableQuoteOrder($input: PlaceNegotiableQuoteOrderInput!) {
  placeNegotiableQuoteOrder(input: $input) {
    order {
      ...OrderFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": PlaceNegotiableQuoteOrderInput}
Response
Copied to your clipboard
{"data": {"placeNegotiableQuoteOrder": {"order": Order}}}

placeOrder

Convert the quote into an order.

Response: PlaceOrderOutput

Arguments

NameDescription
input - PlaceOrderInput
An input object that defines the shopper's cart ID.

Example

Query
Copied to your clipboard
mutation placeOrder($input: PlaceOrderInput) {
  placeOrder(input: $input) {
    errors {
      ...PlaceOrderErrorFragment
    }
    order {
      ...OrderFragment
    }
    orderV2 {
      ...CustomerOrderFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": PlaceOrderInput}
Response
Copied to your clipboard
{
  "data": {
    "placeOrder": {
      "errors": [PlaceOrderError],
      "order": Order,
      "orderV2": CustomerOrder
    }
  }
}

placeOrderForPurchaseOrder

Convert the purchase order into an order.

Response: PlaceOrderForPurchaseOrderOutput

Arguments

NameDescription
input - PlaceOrderForPurchaseOrderInput!

Example

Query
Copied to your clipboard
mutation placeOrderForPurchaseOrder($input: PlaceOrderForPurchaseOrderInput!) {
  placeOrderForPurchaseOrder(input: $input) {
    order {
      ...CustomerOrderFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": PlaceOrderForPurchaseOrderInput}
Response
Copied to your clipboard
{
  "data": {
    "placeOrderForPurchaseOrder": {"order": CustomerOrder}
  }
}

placePurchaseOrder

Place a purchase order.

Response: PlacePurchaseOrderOutput

Arguments

NameDescription
input - PlacePurchaseOrderInput!

Example

Query
Copied to your clipboard
mutation placePurchaseOrder($input: PlacePurchaseOrderInput!) {
  placePurchaseOrder(input: $input) {
    purchase_order {
      ...PurchaseOrderFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": PlacePurchaseOrderInput}
Response
Copied to your clipboard
{
  "data": {
    "placePurchaseOrder": {
      "purchase_order": PurchaseOrder
    }
  }
}

redeemGiftCardBalanceAsStoreCredit

Redeem a gift card for store credit.

Response: GiftCardAccount

Arguments

NameDescription
input - GiftCardAccountInput!
An input object that specifies the gift card code to redeem.

Example

Query
Copied to your clipboard
mutation redeemGiftCardBalanceAsStoreCredit($input: GiftCardAccountInput!) {
  redeemGiftCardBalanceAsStoreCredit(input: $input) {
    balance {
      ...MoneyFragment
    }
    code
    expiration_date
  }
}
Variables
Copied to your clipboard
{"input": GiftCardAccountInput}
Response
Copied to your clipboard
{
  "data": {
    "redeemGiftCardBalanceAsStoreCredit": {
      "balance": Money,
      "code": "xyz789",
      "expiration_date": "abc123"
    }
  }
}

rejectPurchaseOrders

Reject purchase orders.

Response: PurchaseOrdersActionOutput

Arguments

NameDescription
input - PurchaseOrdersActionInput!

Example

Query
Copied to your clipboard
mutation rejectPurchaseOrders($input: PurchaseOrdersActionInput!) {
  rejectPurchaseOrders(input: $input) {
    errors {
      ...PurchaseOrderActionErrorFragment
    }
    purchase_orders {
      ...PurchaseOrderFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": PurchaseOrdersActionInput}
Response
Copied to your clipboard
{
  "data": {
    "rejectPurchaseOrders": {
      "errors": [PurchaseOrderActionError],
      "purchase_orders": [PurchaseOrder]
    }
  }
}

removeCouponFromCart

Remove a previously-applied coupon from the cart. The cart must contain at least one item in order to remove the coupon.

Response: RemoveCouponFromCartOutput

Arguments

NameDescription
input - RemoveCouponFromCartInput
An input object that defines which coupon code to remove from the cart.

Example

Query
Copied to your clipboard
mutation removeCouponFromCart($input: RemoveCouponFromCartInput) {
  removeCouponFromCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": RemoveCouponFromCartInput}
Response
Copied to your clipboard
{"data": {"removeCouponFromCart": {"cart": Cart}}}

removeCouponsFromCart

Remove a previously-applied coupon from the cart. The cart must contain at least one item in order to remove the coupon.

Response: RemoveCouponFromCartOutput

Arguments

NameDescription
input - RemoveCouponsFromCartInput
An input object that defines which coupon code to remove from the cart.

Example

Query
Copied to your clipboard
mutation removeCouponsFromCart($input: RemoveCouponsFromCartInput) {
  removeCouponsFromCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": RemoveCouponsFromCartInput}
Response
Copied to your clipboard
{"data": {"removeCouponsFromCart": {"cart": Cart}}}

removeGiftCardFromCart

Removes a gift card from the cart.

Response: RemoveGiftCardFromCartOutput

Arguments

NameDescription
input - RemoveGiftCardFromCartInput
An input object that specifies which gift card code to remove from the cart.

Example

Query
Copied to your clipboard
mutation removeGiftCardFromCart($input: RemoveGiftCardFromCartInput) {
  removeGiftCardFromCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": RemoveGiftCardFromCartInput}
Response
Copied to your clipboard
{"data": {"removeGiftCardFromCart": {"cart": Cart}}}

removeGiftRegistry

Delete the specified gift registry.

Response: RemoveGiftRegistryOutput

Arguments

NameDescription
giftRegistryUid - ID!
The unique ID of the gift registry to delete.

Example

Query
Copied to your clipboard
mutation removeGiftRegistry($giftRegistryUid: ID!) {
  removeGiftRegistry(giftRegistryUid: $giftRegistryUid) {
    success
  }
}
Variables
Copied to your clipboard
{"giftRegistryUid": 4}
Response
Copied to your clipboard
{"data": {"removeGiftRegistry": {"success": true}}}

removeGiftRegistryItems

Delete the specified items from a gift registry.

Response: RemoveGiftRegistryItemsOutput

Arguments

NameDescription
giftRegistryUid - ID!
The unique ID of the gift registry.
itemsUid - [ID!]!
An array of item IDs to remove from the gift registry.

Example

Query
Copied to your clipboard
mutation removeGiftRegistryItems(
  $giftRegistryUid: ID!,
  $itemsUid: [ID!]!
) {
  removeGiftRegistryItems(
    giftRegistryUid: $giftRegistryUid,
    itemsUid: $itemsUid
  ) {
    gift_registry {
      ...GiftRegistryFragment
    }
  }
}
Variables
Copied to your clipboard
{"giftRegistryUid": 4, "itemsUid": [4]}
Response
Copied to your clipboard
{
  "data": {
    "removeGiftRegistryItems": {
      "gift_registry": GiftRegistry
    }
  }
}

removeGiftRegistryRegistrants

Removes registrants from a gift registry.

Response: RemoveGiftRegistryRegistrantsOutput

Arguments

NameDescription
giftRegistryUid - ID!
The unique ID of the gift registry.
registrantsUid - [ID!]!
An array of registrant IDs to remove.

Example

Query
Copied to your clipboard
mutation removeGiftRegistryRegistrants(
  $giftRegistryUid: ID!,
  $registrantsUid: [ID!]!
) {
  removeGiftRegistryRegistrants(
    giftRegistryUid: $giftRegistryUid,
    registrantsUid: $registrantsUid
  ) {
    gift_registry {
      ...GiftRegistryFragment
    }
  }
}
Variables
Copied to your clipboard
{
  "giftRegistryUid": "4",
  "registrantsUid": ["4"]
}
Response
Copied to your clipboard
{
  "data": {
    "removeGiftRegistryRegistrants": {
      "gift_registry": GiftRegistry
    }
  }
}

removeItemFromCart

Delete the entire quantity of a specified item from the cart. If you remove all items from the cart, the cart continues to exist.

Response: RemoveItemFromCartOutput

Arguments

NameDescription
input - RemoveItemFromCartInput
An input object that defines which products to remove from the cart.

Example

Query
Copied to your clipboard
mutation removeItemFromCart($input: RemoveItemFromCartInput) {
  removeItemFromCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": RemoveItemFromCartInput}
Response
Copied to your clipboard
{"data": {"removeItemFromCart": {"cart": Cart}}}

removeNegotiableQuoteItems

Remove one or more products from a negotiable quote.

Response: RemoveNegotiableQuoteItemsOutput

Arguments

NameDescription
input - RemoveNegotiableQuoteItemsInput!
An input object that removes one or more items from a negotiable quote.

Example

Query
Copied to your clipboard
mutation removeNegotiableQuoteItems($input: RemoveNegotiableQuoteItemsInput!) {
  removeNegotiableQuoteItems(input: $input) {
    quote {
      ...NegotiableQuoteFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": RemoveNegotiableQuoteItemsInput}
Response
Copied to your clipboard
{
  "data": {
    "removeNegotiableQuoteItems": {
      "quote": NegotiableQuote
    }
  }
}

removeNegotiableQuoteTemplateItems

Remove one or more products from a negotiable quote template.

Response: NegotiableQuoteTemplate

Arguments

NameDescription
input - RemoveNegotiableQuoteTemplateItemsInput!
An input object that removes one or more items from a negotiable quote template.

Example

Query
Copied to your clipboard
mutation removeNegotiableQuoteTemplateItems($input: RemoveNegotiableQuoteTemplateItemsInput!) {
  removeNegotiableQuoteTemplateItems(input: $input) {
    buyer {
      ...NegotiableQuoteUserFragment
    }
    comments {
      ...NegotiableQuoteCommentFragment
    }
    expiration_date
    history {
      ...NegotiableQuoteHistoryEntryFragment
    }
    is_min_max_qty_used
    is_virtual
    items {
      ...CartItemInterfaceFragment
    }
    max_order_commitment
    min_order_commitment
    name
    notifications {
      ...QuoteTemplateNotificationMessageFragment
    }
    prices {
      ...CartPricesFragment
    }
    reference_document_links {
      ...NegotiableQuoteReferenceDocumentLinkFragment
    }
    shipping_addresses {
      ...NegotiableQuoteShippingAddressFragment
    }
    status
    template_id
    total_quantity
  }
}
Variables
Copied to your clipboard
{"input": RemoveNegotiableQuoteTemplateItemsInput}
Response
Copied to your clipboard
{
  "data": {
    "removeNegotiableQuoteTemplateItems": {
      "buyer": NegotiableQuoteUser,
      "comments": [NegotiableQuoteComment],
      "expiration_date": "abc123",
      "history": [NegotiableQuoteHistoryEntry],
      "is_min_max_qty_used": true,
      "is_virtual": false,
      "items": [CartItemInterface],
      "max_order_commitment": 987,
      "min_order_commitment": 123,
      "name": "xyz789",
      "notifications": [QuoteTemplateNotificationMessage],
      "prices": CartPrices,
      "reference_document_links": [
        NegotiableQuoteReferenceDocumentLink
      ],
      "shipping_addresses": [
        NegotiableQuoteShippingAddress
      ],
      "status": "xyz789",
      "template_id": "4",
      "total_quantity": 123.45
    }
  }
}

removeProductsFromCompareList

Remove products from the specified compare list.

Response: CompareList

Arguments

NameDescription
input - RemoveProductsFromCompareListInput
An input object that defines which products to remove from a compare list.

Example

Query
Copied to your clipboard
mutation removeProductsFromCompareList($input: RemoveProductsFromCompareListInput) {
  removeProductsFromCompareList(input: $input) {
    attributes {
      ...ComparableAttributeFragment
    }
    item_count
    items {
      ...ComparableItemFragment
    }
    uid
  }
}
Variables
Copied to your clipboard
{"input": RemoveProductsFromCompareListInput}
Response
Copied to your clipboard
{
  "data": {
    "removeProductsFromCompareList": {
      "attributes": [ComparableAttribute],
      "item_count": 987,
      "items": [ComparableItem],
      "uid": 4
    }
  }
}

removeProductsFromWishlist

Remove one or more products from the specified wish list.

Response: RemoveProductsFromWishlistOutput

Arguments

NameDescription
wishlistId - ID!
The ID of a wish list.
wishlistItemsIds - [ID!]!
An array of item IDs representing products to be removed.

Example

Query
Copied to your clipboard
mutation removeProductsFromWishlist(
  $wishlistId: ID!,
  $wishlistItemsIds: [ID!]!
) {
  removeProductsFromWishlist(
    wishlistId: $wishlistId,
    wishlistItemsIds: $wishlistItemsIds
  ) {
    user_errors {
      ...WishListUserInputErrorFragment
    }
    wishlist {
      ...WishlistFragment
    }
  }
}
Variables
Copied to your clipboard
{"wishlistId": "4", "wishlistItemsIds": [4]}
Response
Copied to your clipboard
{
  "data": {
    "removeProductsFromWishlist": {
      "user_errors": [WishListUserInputError],
      "wishlist": Wishlist
    }
  }
}

removeReturnTracking

Remove a tracked shipment from a return.

Response: RemoveReturnTrackingOutput

Arguments

NameDescription
input - RemoveReturnTrackingInput!
An input object that removes tracking information.

Example

Query
Copied to your clipboard
mutation removeReturnTracking($input: RemoveReturnTrackingInput!) {
  removeReturnTracking(input: $input) {
    return {
      ...ReturnFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": RemoveReturnTrackingInput}
Response
Copied to your clipboard
{"data": {"removeReturnTracking": {"return": Return}}}

removeRewardPointsFromCart

Cancel the application of reward points to the cart.

Response: RemoveRewardPointsFromCartOutput

Arguments

NameDescription
cartId - ID!

Example

Query
Copied to your clipboard
mutation removeRewardPointsFromCart($cartId: ID!) {
  removeRewardPointsFromCart(cartId: $cartId) {
    cart {
      ...CartFragment
    }
  }
}
Variables
Copied to your clipboard
{"cartId": "4"}
Response
Copied to your clipboard
{"data": {"removeRewardPointsFromCart": {"cart": Cart}}}

removeStoreCreditFromCart

Remove store credit that has been applied to the specified cart.

Response: RemoveStoreCreditFromCartOutput

Arguments

NameDescription
input - RemoveStoreCreditFromCartInput!
An input object that specifies the cart ID.

Example

Query
Copied to your clipboard
mutation removeStoreCreditFromCart($input: RemoveStoreCreditFromCartInput!) {
  removeStoreCreditFromCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": RemoveStoreCreditFromCartInput}
Response
Copied to your clipboard
{"data": {"removeStoreCreditFromCart": {"cart": Cart}}}

renameNegotiableQuote

Rename negotiable quote.

Response: RenameNegotiableQuoteOutput

Arguments

NameDescription
input - RenameNegotiableQuoteInput!
An input object that defines the quote item name and comment.

Example

Query
Copied to your clipboard
mutation renameNegotiableQuote($input: RenameNegotiableQuoteInput!) {
  renameNegotiableQuote(input: $input) {
    quote {
      ...NegotiableQuoteFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": RenameNegotiableQuoteInput}
Response
Copied to your clipboard
{
  "data": {
    "renameNegotiableQuote": {"quote": NegotiableQuote}
  }
}

reorderItems

Add all products from a customer's previous order to the cart.

Response: ReorderItemsOutput

Arguments

NameDescription
orderNumber - String!

Example

Query
Copied to your clipboard
mutation reorderItems($orderNumber: String!) {
  reorderItems(orderNumber: $orderNumber) {
    cart {
      ...CartFragment
    }
    userInputErrors {
      ...CheckoutUserInputErrorFragment
    }
  }
}
Variables
Copied to your clipboard
{"orderNumber": "xyz789"}
Response
Copied to your clipboard
{
  "data": {
    "reorderItems": {
      "cart": Cart,
      "userInputErrors": [CheckoutUserInputError]
    }
  }
}

requestGuestOrderCancel

Request to cancel specified guest order.

Response: CancelOrderOutput

Arguments

NameDescription
input - GuestOrderCancelInput!

Example

Query
Copied to your clipboard
mutation requestGuestOrderCancel($input: GuestOrderCancelInput!) {
  requestGuestOrderCancel(input: $input) {
    error
    errorV2 {
      ...CancelOrderErrorFragment
    }
    order {
      ...CustomerOrderFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": GuestOrderCancelInput}
Response
Copied to your clipboard
{
  "data": {
    "requestGuestOrderCancel": {
      "error": "xyz789",
      "errorV2": CancelOrderError,
      "order": CustomerOrder
    }
  }
}

requestGuestReturn

Response: RequestReturnOutput

Arguments

NameDescription
input - RequestGuestReturnInput!
An input object that contains the fields needed to start a return request for guest.

Example

Query
Copied to your clipboard
mutation requestGuestReturn($input: RequestGuestReturnInput!) {
  requestGuestReturn(input: $input) {
    return {
      ...ReturnFragment
    }
    returns {
      ...ReturnsFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": RequestGuestReturnInput}
Response
Copied to your clipboard
{
  "data": {
    "requestGuestReturn": {
      "return": Return,
      "returns": Returns
    }
  }
}

requestNegotiableQuote

Request a new negotiable quote on behalf of the buyer.

Response: RequestNegotiableQuoteOutput

Arguments

NameDescription
input - RequestNegotiableQuoteInput!
An input object that contains a request to initiate a negotiable quote.

Example

Query
Copied to your clipboard
mutation requestNegotiableQuote($input: RequestNegotiableQuoteInput!) {
  requestNegotiableQuote(input: $input) {
    quote {
      ...NegotiableQuoteFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": RequestNegotiableQuoteInput}
Response
Copied to your clipboard
{
  "data": {
    "requestNegotiableQuote": {"quote": NegotiableQuote}
  }
}

requestNegotiableQuoteTemplateFromQuote

Request a new negotiable quote on behalf of the buyer.

Response: NegotiableQuoteTemplate

Arguments

NameDescription
input - RequestNegotiableQuoteTemplateInput!
An input object that contains a request to initiate a negotiable quote template.

Example

Query
Copied to your clipboard
mutation requestNegotiableQuoteTemplateFromQuote($input: RequestNegotiableQuoteTemplateInput!) {
  requestNegotiableQuoteTemplateFromQuote(input: $input) {
    buyer {
      ...NegotiableQuoteUserFragment
    }
    comments {
      ...NegotiableQuoteCommentFragment
    }
    expiration_date
    history {
      ...NegotiableQuoteHistoryEntryFragment
    }
    is_min_max_qty_used
    is_virtual
    items {
      ...CartItemInterfaceFragment
    }
    max_order_commitment
    min_order_commitment
    name
    notifications {
      ...QuoteTemplateNotificationMessageFragment
    }
    prices {
      ...CartPricesFragment
    }
    reference_document_links {
      ...NegotiableQuoteReferenceDocumentLinkFragment
    }
    shipping_addresses {
      ...NegotiableQuoteShippingAddressFragment
    }
    status
    template_id
    total_quantity
  }
}
Variables
Copied to your clipboard
{"input": RequestNegotiableQuoteTemplateInput}
Response
Copied to your clipboard
{
  "data": {
    "requestNegotiableQuoteTemplateFromQuote": {
      "buyer": NegotiableQuoteUser,
      "comments": [NegotiableQuoteComment],
      "expiration_date": "abc123",
      "history": [NegotiableQuoteHistoryEntry],
      "is_min_max_qty_used": false,
      "is_virtual": false,
      "items": [CartItemInterface],
      "max_order_commitment": 123,
      "min_order_commitment": 123,
      "name": "abc123",
      "notifications": [QuoteTemplateNotificationMessage],
      "prices": CartPrices,
      "reference_document_links": [
        NegotiableQuoteReferenceDocumentLink
      ],
      "shipping_addresses": [
        NegotiableQuoteShippingAddress
      ],
      "status": "xyz789",
      "template_id": 4,
      "total_quantity": 123.45
    }
  }
}

requestPasswordResetEmail

Request an email with a reset password token for the registered customer identified by the specified email.

Response: Boolean

Arguments

NameDescription
email - String!
The customer's email address.

Example

Query
Copied to your clipboard
mutation requestPasswordResetEmail($email: String!) {
  requestPasswordResetEmail(email: $email)
}
Variables
Copied to your clipboard
{"email": "abc123"}
Response
Copied to your clipboard
{"data": {"requestPasswordResetEmail": false}}

requestReturn

Initiates a buyer's request to return items for replacement or refund.

Response: RequestReturnOutput

Arguments

NameDescription
input - RequestReturnInput!
An input object that contains the fields needed to start a return request.

Example

Query
Copied to your clipboard
mutation requestReturn($input: RequestReturnInput!) {
  requestReturn(input: $input) {
    return {
      ...ReturnFragment
    }
    returns {
      ...ReturnsFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": RequestReturnInput}
Response
Copied to your clipboard
{
  "data": {
    "requestReturn": {
      "return": Return,
      "returns": Returns
    }
  }
}

resendConfirmationEmail

Resends the confirmation email to a customer.

Response: Boolean

Arguments

NameDescription
email - String!
The email address to send the confirmation email to.

Example

Query
Copied to your clipboard
mutation resendConfirmationEmail($email: String!) {
  resendConfirmationEmail(email: $email)
}
Variables
Copied to your clipboard
{"email": "xyz789"}
Response
Copied to your clipboard
{"data": {"resendConfirmationEmail": false}}

resetPassword

Reset a customer's password using the reset password token that the customer received in an email after requesting it using requestPasswordResetEmail.

Response: Boolean

Arguments

NameDescription
email - String!
The customer's email address.
resetPasswordToken - String!
A runtime token generated by the `requestPasswordResetEmail` mutation.
newPassword - String!
The customer's new password.

Example

Query
Copied to your clipboard
mutation resetPassword(
  $email: String!,
  $resetPasswordToken: String!,
  $newPassword: String!
) {
  resetPassword(
    email: $email,
    resetPasswordToken: $resetPasswordToken,
    newPassword: $newPassword
  )
}
Variables
Copied to your clipboard
{
  "email": "xyz789",
  "resetPasswordToken": "xyz789",
  "newPassword": "xyz789"
}
Response
Copied to your clipboard
{"data": {"resetPassword": false}}

revokeCustomerToken

Revoke the customer token.

Response: RevokeCustomerTokenOutput

Example

Query
Copied to your clipboard
mutation revokeCustomerToken {
  revokeCustomerToken {
    result
  }
}
Response
Copied to your clipboard
{"data": {"revokeCustomerToken": {"result": false}}}

sendEmailToFriend

Send a message on behalf of a customer to the specified email addresses.

Response: SendEmailToFriendOutput

Arguments

NameDescription
input - SendEmailToFriendInput
An input object that defines sender, recipients, and product.

Example

Query
Copied to your clipboard
mutation sendEmailToFriend($input: SendEmailToFriendInput) {
  sendEmailToFriend(input: $input) {
    recipients {
      ...SendEmailToFriendRecipientFragment
    }
    sender {
      ...SendEmailToFriendSenderFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": SendEmailToFriendInput}
Response
Copied to your clipboard
{
  "data": {
    "sendEmailToFriend": {
      "recipients": [SendEmailToFriendRecipient],
      "sender": SendEmailToFriendSender
    }
  }
}

sendNegotiableQuoteForReview

Send the negotiable quote to the seller for review.

Response: SendNegotiableQuoteForReviewOutput

Arguments

NameDescription
input - SendNegotiableQuoteForReviewInput!
An input object that sends a request for the merchant to review a negotiable quote.

Example

Query
Copied to your clipboard
mutation sendNegotiableQuoteForReview($input: SendNegotiableQuoteForReviewInput!) {
  sendNegotiableQuoteForReview(input: $input) {
    quote {
      ...NegotiableQuoteFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": SendNegotiableQuoteForReviewInput}
Response
Copied to your clipboard
{
  "data": {
    "sendNegotiableQuoteForReview": {
      "quote": NegotiableQuote
    }
  }
}

setBillingAddressOnCart

Set the billing address on a specific cart.

Response: SetBillingAddressOnCartOutput

Arguments

NameDescription
input - SetBillingAddressOnCartInput
An input object that defines the billing address to be assigned to the cart.

Example

Query
Copied to your clipboard
mutation setBillingAddressOnCart($input: SetBillingAddressOnCartInput) {
  setBillingAddressOnCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": SetBillingAddressOnCartInput}
Response
Copied to your clipboard
{"data": {"setBillingAddressOnCart": {"cart": Cart}}}

setCartAsInactive

Sets the cart as inactive

Response: SetCartAsInactiveOutput

Arguments

NameDescription
cartId - String!
The customer cart ID

Example

Query
Copied to your clipboard
mutation setCartAsInactive($cartId: String!) {
  setCartAsInactive(cartId: $cartId) {
    error
    success
  }
}
Variables
Copied to your clipboard
{"cartId": "xyz789"}
Response
Copied to your clipboard
{
  "data": {
    "setCartAsInactive": {
      "error": "xyz789",
      "success": false
    }
  }
}

setGiftOptionsOnCart

Set gift options, including gift messages, gift wrapping, gift receipts, and printed cards.

Response: SetGiftOptionsOnCartOutput

Arguments

NameDescription
input - SetGiftOptionsOnCartInput
An input object that defines the selected gift options.

Example

Query
Copied to your clipboard
mutation setGiftOptionsOnCart($input: SetGiftOptionsOnCartInput) {
  setGiftOptionsOnCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": SetGiftOptionsOnCartInput}
Response
Copied to your clipboard
{"data": {"setGiftOptionsOnCart": {"cart": Cart}}}

setGuestEmailOnCart

Assign the email address of a guest to the cart.

Response: SetGuestEmailOnCartOutput

Arguments

NameDescription
input - SetGuestEmailOnCartInput
An input object that defines a guest email address.

Example

Query
Copied to your clipboard
mutation setGuestEmailOnCart($input: SetGuestEmailOnCartInput) {
  setGuestEmailOnCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": SetGuestEmailOnCartInput}
Response
Copied to your clipboard
{"data": {"setGuestEmailOnCart": {"cart": Cart}}}

setLineItemNote

Add buyer's note to a negotiable quote item.

Response: SetLineItemNoteOutput

Arguments

NameDescription
input - LineItemNoteInput!
An input object that defines the quote item note.

Example

Query
Copied to your clipboard
mutation setLineItemNote($input: LineItemNoteInput!) {
  setLineItemNote(input: $input) {
    quote {
      ...NegotiableQuoteFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": LineItemNoteInput}
Response
Copied to your clipboard
{"data": {"setLineItemNote": {"quote": NegotiableQuote}}}

setNegotiableQuoteBillingAddress

Assign a billing address to a negotiable quote.

Response: SetNegotiableQuoteBillingAddressOutput

Arguments

NameDescription
input - SetNegotiableQuoteBillingAddressInput!
An input object that defines the billing address to be assigned to a negotiable quote.

Example

Query
Copied to your clipboard
mutation setNegotiableQuoteBillingAddress($input: SetNegotiableQuoteBillingAddressInput!) {
  setNegotiableQuoteBillingAddress(input: $input) {
    quote {
      ...NegotiableQuoteFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": SetNegotiableQuoteBillingAddressInput}
Response
Copied to your clipboard
{
  "data": {
    "setNegotiableQuoteBillingAddress": {
      "quote": NegotiableQuote
    }
  }
}

setNegotiableQuotePaymentMethod

Set the payment method on a negotiable quote.

Response: SetNegotiableQuotePaymentMethodOutput

Arguments

NameDescription
input - SetNegotiableQuotePaymentMethodInput!
An input object that defines the payment method for the specified negotiable quote.

Example

Query
Copied to your clipboard
mutation setNegotiableQuotePaymentMethod($input: SetNegotiableQuotePaymentMethodInput!) {
  setNegotiableQuotePaymentMethod(input: $input) {
    quote {
      ...NegotiableQuoteFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": SetNegotiableQuotePaymentMethodInput}
Response
Copied to your clipboard
{
  "data": {
    "setNegotiableQuotePaymentMethod": {
      "quote": NegotiableQuote
    }
  }
}

setNegotiableQuoteShippingAddress

Assign a previously-defined address as the shipping address for a negotiable quote.

Response: SetNegotiableQuoteShippingAddressOutput

Arguments

NameDescription
input - SetNegotiableQuoteShippingAddressInput!
An input object that defines the shipping address to be assigned to a negotiable quote.

Example

Query
Copied to your clipboard
mutation setNegotiableQuoteShippingAddress($input: SetNegotiableQuoteShippingAddressInput!) {
  setNegotiableQuoteShippingAddress(input: $input) {
    quote {
      ...NegotiableQuoteFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": SetNegotiableQuoteShippingAddressInput}
Response
Copied to your clipboard
{
  "data": {
    "setNegotiableQuoteShippingAddress": {
      "quote": NegotiableQuote
    }
  }
}

setNegotiableQuoteShippingMethods

Assign the shipping methods on the negotiable quote.

Response: SetNegotiableQuoteShippingMethodsOutput

Arguments

NameDescription
input - SetNegotiableQuoteShippingMethodsInput!
An input object that defines the shipping methods to be assigned to a negotiable quote.

Example

Query
Copied to your clipboard
mutation setNegotiableQuoteShippingMethods($input: SetNegotiableQuoteShippingMethodsInput!) {
  setNegotiableQuoteShippingMethods(input: $input) {
    quote {
      ...NegotiableQuoteFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": SetNegotiableQuoteShippingMethodsInput}
Response
Copied to your clipboard
{
  "data": {
    "setNegotiableQuoteShippingMethods": {
      "quote": NegotiableQuote
    }
  }
}

setNegotiableQuoteTemplateShippingAddress

Assign a previously-defined address as the shipping address for a negotiable quote template.

Response: NegotiableQuoteTemplate

Arguments

NameDescription
input - SetNegotiableQuoteTemplateShippingAddressInput!
An input object that defines the shipping address to be assigned to a negotiable quote template.

Example

Query
Copied to your clipboard
mutation setNegotiableQuoteTemplateShippingAddress($input: SetNegotiableQuoteTemplateShippingAddressInput!) {
  setNegotiableQuoteTemplateShippingAddress(input: $input) {
    buyer {
      ...NegotiableQuoteUserFragment
    }
    comments {
      ...NegotiableQuoteCommentFragment
    }
    expiration_date
    history {
      ...NegotiableQuoteHistoryEntryFragment
    }
    is_min_max_qty_used
    is_virtual
    items {
      ...CartItemInterfaceFragment
    }
    max_order_commitment
    min_order_commitment
    name
    notifications {
      ...QuoteTemplateNotificationMessageFragment
    }
    prices {
      ...CartPricesFragment
    }
    reference_document_links {
      ...NegotiableQuoteReferenceDocumentLinkFragment
    }
    shipping_addresses {
      ...NegotiableQuoteShippingAddressFragment
    }
    status
    template_id
    total_quantity
  }
}
Variables
Copied to your clipboard
{"input": SetNegotiableQuoteTemplateShippingAddressInput}
Response
Copied to your clipboard
{
  "data": {
    "setNegotiableQuoteTemplateShippingAddress": {
      "buyer": NegotiableQuoteUser,
      "comments": [NegotiableQuoteComment],
      "expiration_date": "xyz789",
      "history": [NegotiableQuoteHistoryEntry],
      "is_min_max_qty_used": true,
      "is_virtual": true,
      "items": [CartItemInterface],
      "max_order_commitment": 987,
      "min_order_commitment": 987,
      "name": "abc123",
      "notifications": [QuoteTemplateNotificationMessage],
      "prices": CartPrices,
      "reference_document_links": [
        NegotiableQuoteReferenceDocumentLink
      ],
      "shipping_addresses": [
        NegotiableQuoteShippingAddress
      ],
      "status": "xyz789",
      "template_id": 4,
      "total_quantity": 987.65
    }
  }
}

setPaymentMethodAndPlaceOrder

Deprecated

Should use setPaymentMethodOnCart and placeOrder mutations in single request.

Set the cart payment method and convert the cart into an order.

Response: PlaceOrderOutput

Arguments

NameDescription
input - SetPaymentMethodAndPlaceOrderInput

Example

Query
Copied to your clipboard
mutation setPaymentMethodAndPlaceOrder($input: SetPaymentMethodAndPlaceOrderInput) {
  setPaymentMethodAndPlaceOrder(input: $input) {
    errors {
      ...PlaceOrderErrorFragment
    }
    order {
      ...OrderFragment
    }
    orderV2 {
      ...CustomerOrderFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": SetPaymentMethodAndPlaceOrderInput}
Response
Copied to your clipboard
{
  "data": {
    "setPaymentMethodAndPlaceOrder": {
      "errors": [PlaceOrderError],
      "order": Order,
      "orderV2": CustomerOrder
    }
  }
}

setPaymentMethodOnCart

Apply a payment method to the cart.

Response: SetPaymentMethodOnCartOutput

Arguments

NameDescription
input - SetPaymentMethodOnCartInput
An input object that defines which payment method to apply to the cart.

Example

Query
Copied to your clipboard
mutation setPaymentMethodOnCart($input: SetPaymentMethodOnCartInput) {
  setPaymentMethodOnCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": SetPaymentMethodOnCartInput}
Response
Copied to your clipboard
{"data": {"setPaymentMethodOnCart": {"cart": Cart}}}

setQuoteTemplateLineItemNote

Add buyer's note to a negotiable quote template item.

Response: NegotiableQuoteTemplate

Arguments

NameDescription
input - QuoteTemplateLineItemNoteInput!
An input object that defines the quote template item note.

Example

Query
Copied to your clipboard
mutation setQuoteTemplateLineItemNote($input: QuoteTemplateLineItemNoteInput!) {
  setQuoteTemplateLineItemNote(input: $input) {
    buyer {
      ...NegotiableQuoteUserFragment
    }
    comments {
      ...NegotiableQuoteCommentFragment
    }
    expiration_date
    history {
      ...NegotiableQuoteHistoryEntryFragment
    }
    is_min_max_qty_used
    is_virtual
    items {
      ...CartItemInterfaceFragment
    }
    max_order_commitment
    min_order_commitment
    name
    notifications {
      ...QuoteTemplateNotificationMessageFragment
    }
    prices {
      ...CartPricesFragment
    }
    reference_document_links {
      ...NegotiableQuoteReferenceDocumentLinkFragment
    }
    shipping_addresses {
      ...NegotiableQuoteShippingAddressFragment
    }
    status
    template_id
    total_quantity
  }
}
Variables
Copied to your clipboard
{"input": QuoteTemplateLineItemNoteInput}
Response
Copied to your clipboard
{
  "data": {
    "setQuoteTemplateLineItemNote": {
      "buyer": NegotiableQuoteUser,
      "comments": [NegotiableQuoteComment],
      "expiration_date": "xyz789",
      "history": [NegotiableQuoteHistoryEntry],
      "is_min_max_qty_used": false,
      "is_virtual": false,
      "items": [CartItemInterface],
      "max_order_commitment": 123,
      "min_order_commitment": 123,
      "name": "abc123",
      "notifications": [QuoteTemplateNotificationMessage],
      "prices": CartPrices,
      "reference_document_links": [
        NegotiableQuoteReferenceDocumentLink
      ],
      "shipping_addresses": [
        NegotiableQuoteShippingAddress
      ],
      "status": "xyz789",
      "template_id": 4,
      "total_quantity": 987.65
    }
  }
}

setShippingAddressesOnCart

Set one or more shipping addresses on a specific cart.

Response: SetShippingAddressesOnCartOutput

Arguments

NameDescription
input - SetShippingAddressesOnCartInput
An input object that defines one or more shipping addresses to be assigned to the cart.

Example

Query
Copied to your clipboard
mutation setShippingAddressesOnCart($input: SetShippingAddressesOnCartInput) {
  setShippingAddressesOnCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": SetShippingAddressesOnCartInput}
Response
Copied to your clipboard
{"data": {"setShippingAddressesOnCart": {"cart": Cart}}}

setShippingMethodsOnCart

Set one or more delivery methods on a cart.

Response: SetShippingMethodsOnCartOutput

Arguments

NameDescription
input - SetShippingMethodsOnCartInput
An input object that applies one or more shipping methods to the cart.

Example

Query
Copied to your clipboard
mutation setShippingMethodsOnCart($input: SetShippingMethodsOnCartInput) {
  setShippingMethodsOnCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": SetShippingMethodsOnCartInput}
Response
Copied to your clipboard
{"data": {"setShippingMethodsOnCart": {"cart": Cart}}}

shareGiftRegistry

Send an email about the gift registry to a list of invitees.

Response: ShareGiftRegistryOutput

Arguments

NameDescription
giftRegistryUid - ID!
The unique ID of the gift registry.
sender - ShareGiftRegistrySenderInput!
The sender's email address and gift message.
invitees - [ShareGiftRegistryInviteeInput!]!
An array containing invitee names and email addresses.

Example

Query
Copied to your clipboard
mutation shareGiftRegistry(
  $giftRegistryUid: ID!,
  $sender: ShareGiftRegistrySenderInput!,
  $invitees: [ShareGiftRegistryInviteeInput!]!
) {
  shareGiftRegistry(
    giftRegistryUid: $giftRegistryUid,
    sender: $sender,
    invitees: $invitees
  ) {
    is_shared
  }
}
Variables
Copied to your clipboard
{
  "giftRegistryUid": "4",
  "sender": ShareGiftRegistrySenderInput,
  "invitees": [ShareGiftRegistryInviteeInput]
}
Response
Copied to your clipboard
{"data": {"shareGiftRegistry": {"is_shared": false}}}

submitNegotiableQuoteTemplateForReview

Accept an existing negotiable quote template.

Response: NegotiableQuoteTemplate

Arguments

NameDescription
input - SubmitNegotiableQuoteTemplateForReviewInput!
An input object that contains the data to update a negotiable quote template.

Example

Query
Copied to your clipboard
mutation submitNegotiableQuoteTemplateForReview($input: SubmitNegotiableQuoteTemplateForReviewInput!) {
  submitNegotiableQuoteTemplateForReview(input: $input) {
    buyer {
      ...NegotiableQuoteUserFragment
    }
    comments {
      ...NegotiableQuoteCommentFragment
    }
    expiration_date
    history {
      ...NegotiableQuoteHistoryEntryFragment
    }
    is_min_max_qty_used
    is_virtual
    items {
      ...CartItemInterfaceFragment
    }
    max_order_commitment
    min_order_commitment
    name
    notifications {
      ...QuoteTemplateNotificationMessageFragment
    }
    prices {
      ...CartPricesFragment
    }
    reference_document_links {
      ...NegotiableQuoteReferenceDocumentLinkFragment
    }
    shipping_addresses {
      ...NegotiableQuoteShippingAddressFragment
    }
    status
    template_id
    total_quantity
  }
}
Variables
Copied to your clipboard
{"input": SubmitNegotiableQuoteTemplateForReviewInput}
Response
Copied to your clipboard
{
  "data": {
    "submitNegotiableQuoteTemplateForReview": {
      "buyer": NegotiableQuoteUser,
      "comments": [NegotiableQuoteComment],
      "expiration_date": "abc123",
      "history": [NegotiableQuoteHistoryEntry],
      "is_min_max_qty_used": false,
      "is_virtual": false,
      "items": [CartItemInterface],
      "max_order_commitment": 987,
      "min_order_commitment": 987,
      "name": "abc123",
      "notifications": [QuoteTemplateNotificationMessage],
      "prices": CartPrices,
      "reference_document_links": [
        NegotiableQuoteReferenceDocumentLink
      ],
      "shipping_addresses": [
        NegotiableQuoteShippingAddress
      ],
      "status": "abc123",
      "template_id": "4",
      "total_quantity": 987.65
    }
  }
}

subscribeEmailToNewsletter

Subscribe the specified email to the store's newsletter.

Response: SubscribeEmailToNewsletterOutput

Arguments

NameDescription
email - String!
The email address that will receive the store's newsletter.

Example

Query
Copied to your clipboard
mutation subscribeEmailToNewsletter($email: String!) {
  subscribeEmailToNewsletter(email: $email) {
    status
  }
}
Variables
Copied to your clipboard
{"email": "xyz789"}
Response
Copied to your clipboard
{"data": {"subscribeEmailToNewsletter": {"status": "NOT_ACTIVE"}}}

syncPaymentOrder

Synchronizes the payment order details for further payment processing

Response: Boolean

Arguments

NameDescription
input - SyncPaymentOrderInput
Describes the variables needed to synchronize the payment order details

Example

Query
Copied to your clipboard
mutation syncPaymentOrder($input: SyncPaymentOrderInput) {
  syncPaymentOrder(input: $input)
}
Variables
Copied to your clipboard
{"input": SyncPaymentOrderInput}
Response
Copied to your clipboard
{"data": {"syncPaymentOrder": true}}

updateCartItems

Modify items in the cart.

Response: UpdateCartItemsOutput

Arguments

NameDescription
input - UpdateCartItemsInput
An input object that defines products to be updated.

Example

Query
Copied to your clipboard
mutation updateCartItems($input: UpdateCartItemsInput) {
  updateCartItems(input: $input) {
    cart {
      ...CartFragment
    }
    errors {
      ...CartUserInputErrorFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": UpdateCartItemsInput}
Response
Copied to your clipboard
{
  "data": {
    "updateCartItems": {
      "cart": Cart,
      "errors": [CartUserInputError]
    }
  }
}

updateCompany

Update company information.

Response: UpdateCompanyOutput

Arguments

NameDescription
input - CompanyUpdateInput!

Example

Query
Copied to your clipboard
mutation updateCompany($input: CompanyUpdateInput!) {
  updateCompany(input: $input) {
    company {
      ...CompanyFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": CompanyUpdateInput}
Response
Copied to your clipboard
{"data": {"updateCompany": {"company": Company}}}

updateCompanyRole

Update company role information.

Response: UpdateCompanyRoleOutput

Arguments

NameDescription
input - CompanyRoleUpdateInput!

Example

Query
Copied to your clipboard
mutation updateCompanyRole($input: CompanyRoleUpdateInput!) {
  updateCompanyRole(input: $input) {
    role {
      ...CompanyRoleFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": CompanyRoleUpdateInput}
Response
Copied to your clipboard
{"data": {"updateCompanyRole": {"role": CompanyRole}}}

updateCompanyStructure

Change the parent node of a company team within the current company context.

Response: UpdateCompanyStructureOutput

Arguments

NameDescription
input - CompanyStructureUpdateInput!

Example

Query
Copied to your clipboard
mutation updateCompanyStructure($input: CompanyStructureUpdateInput!) {
  updateCompanyStructure(input: $input) {
    company {
      ...CompanyFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": CompanyStructureUpdateInput}
Response
Copied to your clipboard
{"data": {"updateCompanyStructure": {"company": Company}}}

updateCompanyTeam

Update company team data.

Response: UpdateCompanyTeamOutput

Arguments

NameDescription
input - CompanyTeamUpdateInput!

Example

Query
Copied to your clipboard
mutation updateCompanyTeam($input: CompanyTeamUpdateInput!) {
  updateCompanyTeam(input: $input) {
    team {
      ...CompanyTeamFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": CompanyTeamUpdateInput}
Response
Copied to your clipboard
{"data": {"updateCompanyTeam": {"team": CompanyTeam}}}

updateCompanyUser

Update an existing company user.

Response: UpdateCompanyUserOutput

Arguments

NameDescription
input - CompanyUserUpdateInput!

Example

Query
Copied to your clipboard
mutation updateCompanyUser($input: CompanyUserUpdateInput!) {
  updateCompanyUser(input: $input) {
    user {
      ...CustomerFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": CompanyUserUpdateInput}
Response
Copied to your clipboard
{"data": {"updateCompanyUser": {"user": Customer}}}

updateCustomer

Deprecated

Use updateCustomerV2 instead.

Response: CustomerOutput

Arguments

NameDescription
input - CustomerInput!
An input object that defines the customer characteristics to update.

Example

Query
Copied to your clipboard
mutation updateCustomer($input: CustomerInput!) {
  updateCustomer(input: $input) {
    customer {
      ...CustomerFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": CustomerInput}
Response
Copied to your clipboard
{"data": {"updateCustomer": {"customer": Customer}}}

updateCustomerAddress

Deprecated

Use updateCustomerAddressV2 instead.

Update the billing or shipping address of a customer or guest.

Response: CustomerAddress

Arguments

NameDescription
id - Int!
The ID assigned to the customer address.
input - CustomerAddressInput
An input object that contains changes to the customer address.

Example

Query
Copied to your clipboard
mutation updateCustomerAddress(
  $id: Int!,
  $input: CustomerAddressInput
) {
  updateCustomerAddress(
    id: $id,
    input: $input
  ) {
    city
    company
    country_code
    country_id
    custom_attributes {
      ...CustomerAddressAttributeFragment
    }
    custom_attributesV2 {
      ...AttributeValueInterfaceFragment
    }
    customer_id
    default_billing
    default_shipping
    extension_attributes {
      ...CustomerAddressAttributeFragment
    }
    fax
    firstname
    id
    lastname
    middlename
    postcode
    prefix
    region {
      ...CustomerAddressRegionFragment
    }
    region_id
    street
    suffix
    telephone
    uid
    vat_id
  }
}
Variables
Copied to your clipboard
{"id": 123, "input": CustomerAddressInput}
Response
Copied to your clipboard
{
  "data": {
    "updateCustomerAddress": {
      "city": "abc123",
      "company": "xyz789",
      "country_code": "AF",
      "country_id": "abc123",
      "custom_attributes": [CustomerAddressAttribute],
      "custom_attributesV2": [AttributeValueInterface],
      "customer_id": 123,
      "default_billing": true,
      "default_shipping": true,
      "extension_attributes": [CustomerAddressAttribute],
      "fax": "xyz789",
      "firstname": "abc123",
      "id": 123,
      "lastname": "abc123",
      "middlename": "xyz789",
      "postcode": "abc123",
      "prefix": "xyz789",
      "region": CustomerAddressRegion,
      "region_id": 987,
      "street": ["abc123"],
      "suffix": "abc123",
      "telephone": "abc123",
      "uid": "4",
      "vat_id": "xyz789"
    }
  }
}

updateCustomerAddressV2

Update the billing or shipping address of a customer or guest.

Response: CustomerAddress

Arguments

NameDescription
uid - ID!
The unique ID of the customer address.
input - CustomerAddressInput
An input object that contains changes to the customer address.

Example

Query
Copied to your clipboard
mutation updateCustomerAddressV2(
  $uid: ID!,
  $input: CustomerAddressInput
) {
  updateCustomerAddressV2(
    uid: $uid,
    input: $input
  ) {
    city
    company
    country_code
    country_id
    custom_attributes {
      ...CustomerAddressAttributeFragment
    }
    custom_attributesV2 {
      ...AttributeValueInterfaceFragment
    }
    customer_id
    default_billing
    default_shipping
    extension_attributes {
      ...CustomerAddressAttributeFragment
    }
    fax
    firstname
    id
    lastname
    middlename
    postcode
    prefix
    region {
      ...CustomerAddressRegionFragment
    }
    region_id
    street
    suffix
    telephone
    uid
    vat_id
  }
}
Variables
Copied to your clipboard
{"uid": 4, "input": CustomerAddressInput}
Response
Copied to your clipboard
{
  "data": {
    "updateCustomerAddressV2": {
      "city": "xyz789",
      "company": "abc123",
      "country_code": "AF",
      "country_id": "xyz789",
      "custom_attributes": [CustomerAddressAttribute],
      "custom_attributesV2": [AttributeValueInterface],
      "customer_id": 987,
      "default_billing": true,
      "default_shipping": true,
      "extension_attributes": [CustomerAddressAttribute],
      "fax": "xyz789",
      "firstname": "abc123",
      "id": 123,
      "lastname": "abc123",
      "middlename": "xyz789",
      "postcode": "abc123",
      "prefix": "xyz789",
      "region": CustomerAddressRegion,
      "region_id": 987,
      "street": ["xyz789"],
      "suffix": "abc123",
      "telephone": "xyz789",
      "uid": 4,
      "vat_id": "abc123"
    }
  }
}

updateCustomerEmail

Change the email address for the logged-in customer.

Response: CustomerOutput

Arguments

NameDescription
email - String!
The customer's email address.
password - String!
The customer's password.

Example

Query
Copied to your clipboard
mutation updateCustomerEmail(
  $email: String!,
  $password: String!
) {
  updateCustomerEmail(
    email: $email,
    password: $password
  ) {
    customer {
      ...CustomerFragment
    }
  }
}
Variables
Copied to your clipboard
{
  "email": "xyz789",
  "password": "abc123"
}
Response
Copied to your clipboard
{"data": {"updateCustomerEmail": {"customer": Customer}}}

updateCustomerV2

Update the customer's personal information.

Response: CustomerOutput

Arguments

NameDescription
input - CustomerUpdateInput!
An input object that defines the customer characteristics to update.

Example

Query
Copied to your clipboard
mutation updateCustomerV2($input: CustomerUpdateInput!) {
  updateCustomerV2(input: $input) {
    customer {
      ...CustomerFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": CustomerUpdateInput}
Response
Copied to your clipboard
{"data": {"updateCustomerV2": {"customer": Customer}}}

updateGiftRegistry

Update the specified gift registry.

Response: UpdateGiftRegistryOutput

Arguments

NameDescription
giftRegistryUid - ID!
The unique ID of an existing gift registry.
giftRegistry - UpdateGiftRegistryInput!
An input object that defines which fields to update.

Example

Query
Copied to your clipboard
mutation updateGiftRegistry(
  $giftRegistryUid: ID!,
  $giftRegistry: UpdateGiftRegistryInput!
) {
  updateGiftRegistry(
    giftRegistryUid: $giftRegistryUid,
    giftRegistry: $giftRegistry
  ) {
    gift_registry {
      ...GiftRegistryFragment
    }
  }
}
Variables
Copied to your clipboard
{
  "giftRegistryUid": 4,
  "giftRegistry": UpdateGiftRegistryInput
}
Response
Copied to your clipboard
{
  "data": {
    "updateGiftRegistry": {"gift_registry": GiftRegistry}
  }
}

updateGiftRegistryItems

Update the specified items in the gift registry.

Response: UpdateGiftRegistryItemsOutput

Arguments

NameDescription
giftRegistryUid - ID!
The unique ID of the gift registry.
items - [UpdateGiftRegistryItemInput!]!
An array of items to be updated.

Example

Query
Copied to your clipboard
mutation updateGiftRegistryItems(
  $giftRegistryUid: ID!,
  $items: [UpdateGiftRegistryItemInput!]!
) {
  updateGiftRegistryItems(
    giftRegistryUid: $giftRegistryUid,
    items: $items
  ) {
    gift_registry {
      ...GiftRegistryFragment
    }
  }
}
Variables
Copied to your clipboard
{
  "giftRegistryUid": "4",
  "items": [UpdateGiftRegistryItemInput]
}
Response
Copied to your clipboard
{
  "data": {
    "updateGiftRegistryItems": {
      "gift_registry": GiftRegistry
    }
  }
}

updateGiftRegistryRegistrants

Modify the properties of one or more gift registry registrants.

Response: UpdateGiftRegistryRegistrantsOutput

Arguments

NameDescription
giftRegistryUid - ID!
The unique ID of the gift registry.
registrants - [UpdateGiftRegistryRegistrantInput!]!
An array of registrants to update.

Example

Query
Copied to your clipboard
mutation updateGiftRegistryRegistrants(
  $giftRegistryUid: ID!,
  $registrants: [UpdateGiftRegistryRegistrantInput!]!
) {
  updateGiftRegistryRegistrants(
    giftRegistryUid: $giftRegistryUid,
    registrants: $registrants
  ) {
    gift_registry {
      ...GiftRegistryFragment
    }
  }
}
Variables
Copied to your clipboard
{
  "giftRegistryUid": 4,
  "registrants": [UpdateGiftRegistryRegistrantInput]
}
Response
Copied to your clipboard
{
  "data": {
    "updateGiftRegistryRegistrants": {
      "gift_registry": GiftRegistry
    }
  }
}

updateNegotiableQuoteQuantities

Change the quantity of one or more items in an existing negotiable quote.

Response: UpdateNegotiableQuoteItemsQuantityOutput

Arguments

NameDescription
input - UpdateNegotiableQuoteQuantitiesInput!
An input object that changes the quantity of one or more items in a negotiable quote.

Example

Query
Copied to your clipboard
mutation updateNegotiableQuoteQuantities($input: UpdateNegotiableQuoteQuantitiesInput!) {
  updateNegotiableQuoteQuantities(input: $input) {
    quote {
      ...NegotiableQuoteFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": UpdateNegotiableQuoteQuantitiesInput}
Response
Copied to your clipboard
{
  "data": {
    "updateNegotiableQuoteQuantities": {
      "quote": NegotiableQuote
    }
  }
}

updateNegotiableQuoteTemplateQuantities

Change the quantity of one or more items in an existing negotiable quote template.

Response: UpdateNegotiableQuoteTemplateItemsQuantityOutput

Arguments

NameDescription
input - UpdateNegotiableQuoteTemplateQuantitiesInput!
An input object that changes the quantity of one or more items in a negotiable quote template.

Example

Query
Copied to your clipboard
mutation updateNegotiableQuoteTemplateQuantities($input: UpdateNegotiableQuoteTemplateQuantitiesInput!) {
  updateNegotiableQuoteTemplateQuantities(input: $input) {
    quote_template {
      ...NegotiableQuoteTemplateFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": UpdateNegotiableQuoteTemplateQuantitiesInput}
Response
Copied to your clipboard
{
  "data": {
    "updateNegotiableQuoteTemplateQuantities": {
      "quote_template": NegotiableQuoteTemplate
    }
  }
}

updateProductsInWishlist

Update one or more products in the specified wish list.

Response: UpdateProductsInWishlistOutput

Arguments

NameDescription
wishlistId - ID!
The ID of a wish list.
wishlistItems - [WishlistItemUpdateInput!]!
An array of items to be updated.

Example

Query
Copied to your clipboard
mutation updateProductsInWishlist(
  $wishlistId: ID!,
  $wishlistItems: [WishlistItemUpdateInput!]!
) {
  updateProductsInWishlist(
    wishlistId: $wishlistId,
    wishlistItems: $wishlistItems
  ) {
    user_errors {
      ...WishListUserInputErrorFragment
    }
    wishlist {
      ...WishlistFragment
    }
  }
}
Variables
Copied to your clipboard
{
  "wishlistId": 4,
  "wishlistItems": [WishlistItemUpdateInput]
}
Response
Copied to your clipboard
{
  "data": {
    "updateProductsInWishlist": {
      "user_errors": [WishListUserInputError],
      "wishlist": Wishlist
    }
  }
}

updatePurchaseOrderApprovalRule

Update existing purchase order approval rules.

Response: PurchaseOrderApprovalRule

Arguments

NameDescription
input - UpdatePurchaseOrderApprovalRuleInput!

Example

Query
Copied to your clipboard
mutation updatePurchaseOrderApprovalRule($input: UpdatePurchaseOrderApprovalRuleInput!) {
  updatePurchaseOrderApprovalRule(input: $input) {
    applies_to_roles {
      ...CompanyRoleFragment
    }
    approver_roles {
      ...CompanyRoleFragment
    }
    condition {
      ...PurchaseOrderApprovalRuleConditionInterfaceFragment
    }
    created_at
    created_by
    description
    name
    status
    uid
    updated_at
  }
}
Variables
Copied to your clipboard
{"input": UpdatePurchaseOrderApprovalRuleInput}
Response
Copied to your clipboard
{
  "data": {
    "updatePurchaseOrderApprovalRule": {
      "applies_to_roles": [CompanyRole],
      "approver_roles": [CompanyRole],
      "condition": PurchaseOrderApprovalRuleConditionInterface,
      "created_at": "xyz789",
      "created_by": "abc123",
      "description": "abc123",
      "name": "abc123",
      "status": "ENABLED",
      "uid": 4,
      "updated_at": "abc123"
    }
  }
}

updateRequisitionList

Rename a requisition list and change its description.

Response: UpdateRequisitionListOutput

Arguments

NameDescription
requisitionListUid - ID!
The unique ID of the requisition list.
input - UpdateRequisitionListInput

Example

Query
Copied to your clipboard
mutation updateRequisitionList(
  $requisitionListUid: ID!,
  $input: UpdateRequisitionListInput
) {
  updateRequisitionList(
    requisitionListUid: $requisitionListUid,
    input: $input
  ) {
    requisition_list {
      ...RequisitionListFragment
    }
  }
}
Variables
Copied to your clipboard
{
  "requisitionListUid": 4,
  "input": UpdateRequisitionListInput
}
Response
Copied to your clipboard
{
  "data": {
    "updateRequisitionList": {
      "requisition_list": RequisitionList
    }
  }
}

updateRequisitionListItems

Update items in a requisition list.

Response: UpdateRequisitionListItemsOutput

Arguments

NameDescription
requisitionListUid - ID!
The unique ID of the requisition list.
requisitionListItems - [UpdateRequisitionListItemsInput!]!
Items to be updated in the requisition list.

Example

Query
Copied to your clipboard
mutation updateRequisitionListItems(
  $requisitionListUid: ID!,
  $requisitionListItems: [UpdateRequisitionListItemsInput!]!
) {
  updateRequisitionListItems(
    requisitionListUid: $requisitionListUid,
    requisitionListItems: $requisitionListItems
  ) {
    requisition_list {
      ...RequisitionListFragment
    }
  }
}
Variables
Copied to your clipboard
{
  "requisitionListUid": "4",
  "requisitionListItems": [
    UpdateRequisitionListItemsInput
  ]
}
Response
Copied to your clipboard
{
  "data": {
    "updateRequisitionListItems": {
      "requisition_list": RequisitionList
    }
  }
}

updateWishlist

Change the name and visibility of the specified wish list.

Response: UpdateWishlistOutput

Arguments

NameDescription
wishlistId - ID!
The ID of the wish list to update.
name - String
The name assigned to the wish list.
visibility - WishlistVisibilityEnum
Indicates the visibility of the wish list.

Example

Query
Copied to your clipboard
mutation updateWishlist(
  $wishlistId: ID!,
  $name: String,
  $visibility: WishlistVisibilityEnum
) {
  updateWishlist(
    wishlistId: $wishlistId,
    name: $name,
    visibility: $visibility
  ) {
    name
    uid
    visibility
  }
}
Variables
Copied to your clipboard
{
  "wishlistId": "4",
  "name": "xyz789",
  "visibility": "PUBLIC"
}
Response
Copied to your clipboard
{
  "data": {
    "updateWishlist": {
      "name": "xyz789",
      "uid": 4,
      "visibility": "PUBLIC"
    }
  }
}

validatePurchaseOrders

Validate purchase orders.

Response: ValidatePurchaseOrdersOutput

Arguments

NameDescription
input - ValidatePurchaseOrdersInput!

Example

Query
Copied to your clipboard
mutation validatePurchaseOrders($input: ValidatePurchaseOrdersInput!) {
  validatePurchaseOrders(input: $input) {
    errors {
      ...ValidatePurchaseOrderErrorFragment
    }
    purchase_orders {
      ...PurchaseOrderFragment
    }
  }
}
Variables
Copied to your clipboard
{"input": ValidatePurchaseOrdersInput}
Response
Copied to your clipboard
{
  "data": {
    "validatePurchaseOrders": {
      "errors": [ValidatePurchaseOrderError],
      "purchase_orders": [PurchaseOrder]
    }
  }
}

Types

AcceptNegotiableQuoteTemplateInput

Specifies the quote template id to accept quote template.

Input Fields

Input FieldDescription
template_id - ID!
The unique ID of a `NegotiableQuoteTemplate` object.

Example

Copied to your clipboard
{"template_id": "4"}

AddBundleProductsToCartInput

Defines the bundle products to add to the cart.

Input Fields

Input FieldDescription
cart_id - String!
The ID of the cart.
cart_items - [BundleProductCartItemInput]!
An array of bundle products to add.

Example

Copied to your clipboard
{
  "cart_id": "xyz789",
  "cart_items": [BundleProductCartItemInput]
}

AddBundleProductsToCartOutput

Contains details about the cart after adding bundle products.

Fields

Field NameDescription
cart - Cart!
The cart after adding products.

Example

Copied to your clipboard
{"cart": Cart}

AddConfigurableProductsToCartInput

Defines the configurable products to add to the cart.

Input Fields

Input FieldDescription
cart_id - String!
The ID of the cart.
cart_items - [ConfigurableProductCartItemInput]!
An array of configurable products to add.

Example

Copied to your clipboard
{
  "cart_id": "abc123",
  "cart_items": [ConfigurableProductCartItemInput]
}

AddConfigurableProductsToCartOutput

Contains details about the cart after adding configurable products.

Fields

Field NameDescription
cart - Cart!
The cart after adding products.

Example

Copied to your clipboard
{"cart": Cart}

AddDownloadableProductsToCartInput

Input Fields

Input FieldDescription
cart_id - String!
The ID of the cart.
cart_items - [DownloadableProductCartItemInput]!
An array of downloadable products to add.

Example

Copied to your clipboard
{
  "cart_id": "xyz789",
  "cart_items": [DownloadableProductCartItemInput]
}

AddDownloadableProductsToCartOutput

Contains details about the cart after adding downloadable products.

Fields

Field NameDescription
cart - Cart!
The cart after adding products.

Example

Copied to your clipboard
{"cart": Cart}

AddGiftRegistryRegistrantInput

Defines a new registrant.

Input Fields

Input FieldDescription
dynamic_attributes - [GiftRegistryDynamicAttributeInput]
Additional attributes specified as a code-value pair.
email - String!
The email address of the registrant.
firstname - String!
The first name of the registrant.
lastname - String!
The last name of the registrant.

Example

Copied to your clipboard
{
  "dynamic_attributes": [
    GiftRegistryDynamicAttributeInput
  ],
  "email": "xyz789",
  "firstname": "xyz789",
  "lastname": "xyz789"
}

AddGiftRegistryRegistrantsOutput

Contains the results of a request to add registrants.

Fields

Field NameDescription
gift_registry - GiftRegistry
The gift registry after adding registrants.

Example

Copied to your clipboard
{"gift_registry": GiftRegistry}

AddProductsToCartOutput

Contains details about the cart after adding products to it.

Fields

Field NameDescription
cart - Cart!
The cart after products have been added.
user_errors - [Error]!
Contains errors encountered while adding an item to the cart.

Example

Copied to your clipboard
{
  "cart": Cart,
  "user_errors": [Error]
}

AddProductsToCompareListInput

Contains products to add to an existing compare list.

Input Fields

Input FieldDescription
products - [ID]!
An array of product IDs to add to the compare list.
uid - ID!
The unique identifier of the compare list to modify.

Example

Copied to your clipboard
{
  "products": ["4"],
  "uid": "4"
}

AddProductsToNewCartOutput

Contains details about the cart after adding products to it.

Fields

Field NameDescription
cart - Cart
The cart after products have been added.
user_errors - [CartUserInputError]
Contains errors encountered while adding an item to the cart.

Example

Copied to your clipboard
{
  "cart": Cart,
  "user_errors": [CartUserInputError]
}

AddProductsToRequisitionListOutput

Output of the request to add products to a requisition list.

Fields

Field NameDescription
requisition_list - RequisitionList
The requisition list after adding products.

Example

Copied to your clipboard
{"requisition_list": RequisitionList}

AddProductsToWishlistOutput

Contains the customer's wish list and any errors encountered.

Fields

Field NameDescription
user_errors - [WishListUserInputError]!
An array of errors encountered while adding products to a wish list.
wishlist - Wishlist!
Contains the wish list with all items that were successfully added.

Example

Copied to your clipboard
{
  "user_errors": [WishListUserInputError],
  "wishlist": Wishlist
}

AddPurchaseOrderCommentInput

Contains the comment to be added to a purchase order.

Input Fields

Input FieldDescription
comment - String!
Comment text.
purchase_order_uid - ID!
The unique ID of a purchase order.

Example

Copied to your clipboard
{
  "comment": "xyz789",
  "purchase_order_uid": "4"
}

AddPurchaseOrderCommentOutput

Contains the successfully added comment.

Fields

Field NameDescription
comment - PurchaseOrderComment!
The purchase order comment.

Example

Copied to your clipboard
{"comment": PurchaseOrderComment}

AddPurchaseOrderItemsToCartInput

Defines the purchase order and cart to act on.

Input Fields

Input FieldDescription
cart_id - String!
The ID to assign to the cart.
purchase_order_uid - ID!
Purchase order unique ID.
replace_existing_cart_items - Boolean!
Replace existing cart or merge items.

Example

Copied to your clipboard
{
  "cart_id": "xyz789",
  "purchase_order_uid": 4,
  "replace_existing_cart_items": false
}

AddRequisitionListItemToCartUserError

Contains details about why an attempt to add items to the requistion list failed.

Fields

Field NameDescription
message - String!
A description of the error.
type - AddRequisitionListItemToCartUserErrorType!
The type of error that occurred.

Example

Copied to your clipboard
{
  "message": "abc123",
  "type": "OUT_OF_STOCK"
}

AddRequisitionListItemToCartUserErrorType

Values

Enum ValueDescription
OUT_OF_STOCK
UNAVAILABLE_SKU
OPTIONS_UPDATED
LOW_QUANTITY

Example

Copied to your clipboard
""OUT_OF_STOCK""

AddRequisitionListItemsToCartOutput

Output of the request to add items in a requisition list to the cart.

Fields

Field NameDescription
add_requisition_list_items_to_cart_user_errors - [AddRequisitionListItemToCartUserError]!
Details about why the attempt to add items to the requistion list was not successful.
cart - Cart
The cart after adding requisition list items.
status - Boolean!
Indicates whether the attempt to add items to the requisition list was successful.

Example

Copied to your clipboard
{
  "add_requisition_list_items_to_cart_user_errors": [
    AddRequisitionListItemToCartUserError
  ],
  "cart": Cart,
  "status": false
}

AddReturnCommentInput

Defines a return comment.

Input Fields

Input FieldDescription
comment_text - String!
The text added to the return request.
return_uid - ID!
The unique ID for a `Return` object.

Example

Copied to your clipboard
{"comment_text": "xyz789", "return_uid": 4}

AddReturnCommentOutput

Contains details about the return request.

Fields

Field NameDescription
return - Return
The modified return.

Example

Copied to your clipboard
{"return": Return}

AddReturnTrackingInput

Defines tracking information to be added to the return.

Input Fields

Input FieldDescription
carrier_uid - ID!
The unique ID for a `ReturnShippingCarrier` object.
return_uid - ID!
The unique ID for a `Returns` object.
tracking_number - String!
The shipping tracking number for this return request.

Example

Copied to your clipboard
{
  "carrier_uid": 4,
  "return_uid": "4",
  "tracking_number": "xyz789"
}

AddReturnTrackingOutput

Contains the response after adding tracking information.

Fields

Field NameDescription
return - Return
Details about the modified return.
return_shipping_tracking - ReturnShippingTracking
Details about shipping for a return.

Example

Copied to your clipboard
{
  "return": Return,
  "return_shipping_tracking": ReturnShippingTracking
}

AddSimpleProductsToCartInput

Defines the simple and group products to add to the cart.

Input Fields

Input FieldDescription
cart_id - String!
The unique ID of a `Cart` object.
cart_items - [SimpleProductCartItemInput]!
An array of simple and group items to add.

Example

Copied to your clipboard
{
  "cart_id": "abc123",
  "cart_items": [SimpleProductCartItemInput]
}

AddSimpleProductsToCartOutput

Contains details about the cart after adding simple or group products.

Fields

Field NameDescription
cart - Cart!
The cart after adding products.

Example

Copied to your clipboard
{"cart": Cart}

AddVirtualProductsToCartInput

Defines the virtual products to add to the cart.

Input Fields

Input FieldDescription
cart_id - String!
The unique ID of a `Cart` object.
cart_items - [VirtualProductCartItemInput]!
An array of virtual products to add.

Example

Copied to your clipboard
{
  "cart_id": "abc123",
  "cart_items": [VirtualProductCartItemInput]
}

AddVirtualProductsToCartOutput

Contains details about the cart after adding virtual products.

Fields

Field NameDescription
cart - Cart!
The cart after adding products.

Example

Copied to your clipboard
{"cart": Cart}

AddWishlistItemsToCartOutput

Contains the resultant wish list and any error information.

Fields

Field NameDescription
add_wishlist_items_to_cart_user_errors - [WishlistCartUserInputError]!
An array of errors encountered while adding products to the customer's cart.
status - Boolean!
Indicates whether the attempt to add items to the customer's cart was successful.
wishlist - Wishlist!
Contains the wish list with all items that were successfully added.

Example

Copied to your clipboard
{
  "add_wishlist_items_to_cart_user_errors": [
    WishlistCartUserInputError
  ],
  "status": true,
  "wishlist": Wishlist
}

Aggregation

Contains information for each filterable option (such as price, category UID, and custom attributes).

Fields

Field NameDescription
attribute_code - String!
Attribute code of the aggregation group.
count - Int
The number of options in the aggregation group.
label - String
The aggregation display name.
options - [AggregationOption]
Array of options for the aggregation.
position - Int
The relative position of the attribute in a layered navigation block.

Example

Copied to your clipboard
{
  "attribute_code": "xyz789",
  "count": 123,
  "label": "abc123",
  "options": [AggregationOption],
  "position": 123
}

AggregationOption

An implementation of AggregationOptionInterface.

Fields

Field NameDescription
count - Int
The number of items that match the aggregation option.
label - String
The display label for an aggregation option.
value - String!
The internal ID that represents the value of the option.

Example

Copied to your clipboard
{
  "count": 987,
  "label": "abc123",
  "value": "xyz789"
}

AggregationOptionInterface

Defines aggregation option fields.

Fields

Field NameDescription
count - Int
The number of items that match the aggregation option.
label - String
The display label for an aggregation option.
value - String!
The internal ID that represents the value of the option.

Possible Types

AggregationOptionInterface Types
AggregationOption

Example

Copied to your clipboard
{
  "count": 123,
  "label": "xyz789",
  "value": "abc123"
}

AggregationsCategoryFilterInput

Filter category aggregations in layered navigation.

Input Fields

Input FieldDescription
includeDirectChildrenOnly - Boolean
Indicates whether to include only direct subcategories or all children categories at all levels.

Example

Copied to your clipboard
{"includeDirectChildrenOnly": false}

AggregationsFilterInput

An input object that specifies the filters used in product aggregations.

Input Fields

Input FieldDescription
category - AggregationsCategoryFilterInput
Filter category aggregations in layered navigation.

Example

Copied to your clipboard
{"category": AggregationsCategoryFilterInput}

ApplePayConfig

Fields

Field NameDescription
button_styles - ButtonStyles
The styles for the ApplePay Smart Button configuration
code - String
The payment method code as defined in the payment gateway
is_visible - Boolean
Indicates whether the payment method is displayed
payment_intent - String
Defines the payment intent (Authorize or Capture
payment_source - String
The payment source for the payment method
sdk_params - [SDKParams]
The PayPal parameters required to load the JS SDK
sort_order - String
The relative order the payment method is displayed on the checkout page
title - String
The name displayed for the payment method

Example

Copied to your clipboard
{
  "button_styles": ButtonStyles,
  "code": "abc123",
  "is_visible": false,
  "payment_intent": "abc123",
  "payment_source": "xyz789",
  "sdk_params": [SDKParams],
  "sort_order": "abc123",
  "title": "xyz789"
}

ApplePayMethodInput

Apple Pay inputs

Input Fields

Input FieldDescription
payment_source - String
The payment source for the payment method
payments_order_id - String
The payment services order ID
paypal_order_id - String
PayPal order ID

Example

Copied to your clipboard
{
  "payment_source": "xyz789",
  "payments_order_id": "xyz789",
  "paypal_order_id": "xyz789"
}

AppliedCoupon

Contains the applied coupon code.

Fields

Field NameDescription
code - String!
The coupon code the shopper applied to the card.

Example

Copied to your clipboard
{"code": "xyz789"}

AppliedGiftCard

Contains an applied gift card with applied and remaining balance.

Fields

Field NameDescription
applied_balance - Money
The amount applied to the current cart.
code - String
The gift card account code.
current_balance - Money
The remaining balance on the gift card.
expiration_date - String
The expiration date of the gift card.

Example

Copied to your clipboard
{
  "applied_balance": Money,
  "code": "abc123",
  "current_balance": Money,
  "expiration_date": "abc123"
}

AppliedStoreCredit

Contains the applied and current balances.

Fields

Field NameDescription
applied_balance - Money
The applied store credit balance to the current cart.
current_balance - Money
The current balance remaining on store credit.
enabled - Boolean
Indicates whether store credits are enabled. If the feature is disabled, then the current balance will not be returned.

Example

Copied to your clipboard
{
  "applied_balance": Money,
  "current_balance": Money,
  "enabled": true
}

ApplyCouponToCartInput

Specifies the coupon code to apply to the cart.

Input Fields

Input FieldDescription
cart_id - String!
The unique ID of a `Cart` object.
coupon_code - String!
A valid coupon code.

Example

Copied to your clipboard
{
  "cart_id": "xyz789",
  "coupon_code": "abc123"
}

ApplyCouponToCartOutput

Contains details about the cart after applying a coupon.

Fields

Field NameDescription
cart - Cart!
The cart after applying a coupon.

Example

Copied to your clipboard
{"cart": Cart}

ApplyCouponsStrategy

The strategy to apply coupons to the cart.

Values

Enum ValueDescription
APPEND
Append new coupons keeping the coupons that have been applied before.
REPLACE
Remove all the coupons from the cart and apply only new provided coupons.

Example

Copied to your clipboard
""APPEND""

ApplyCouponsToCartInput

Apply coupons to the cart.

Input Fields

Input FieldDescription
cart_id - String!
The unique ID of a `Cart` object.
coupon_codes - [String]!
An array of valid coupon codes.
type - ApplyCouponsStrategy
`replace` to replace the existing coupon(s) or `append` to add the coupon to the coupon(s) list.

Example

Copied to your clipboard
{
  "cart_id": "xyz789",
  "coupon_codes": ["abc123"],
  "type": "APPEND"
}

ApplyGiftCardToCartInput

Defines the input required to run the applyGiftCardToCart mutation.

Input Fields

Input FieldDescription
cart_id - String!
The unique ID that identifies the customer's cart.
gift_card_code - String!
The gift card code to be applied to the cart.

Example

Copied to your clipboard
{
  "cart_id": "abc123",
  "gift_card_code": "xyz789"
}

ApplyGiftCardToCartOutput

Defines the possible output for the applyGiftCardToCart mutation.

Fields

Field NameDescription
cart - Cart!
Describes the contents of the specified shopping cart.

Example

Copied to your clipboard
{"cart": Cart}

ApplyGiftCardToOrder

Contains applied gift cards with gift card code and amount.

Fields

Field NameDescription
applied_balance - Money!
The gift card amount applied to the current order.
code - String!
The gift card account code.

Example

Copied to your clipboard
{
  "applied_balance": Money,
  "code": "abc123"
}

ApplyRewardPointsToCartOutput

Contains the customer cart.

Fields

Field NameDescription
cart - Cart!
The customer cart after reward points are applied.

Example

Copied to your clipboard
{"cart": Cart}

ApplyStoreCreditToCartInput

Defines the input required to run the applyStoreCreditToCart mutation.

Input Fields

Input FieldDescription
cart_id - String!
The unique ID that identifies the customer's cart.

Example

Copied to your clipboard
{"cart_id": "xyz789"}

ApplyStoreCreditToCartOutput

Defines the possible output for the applyStoreCreditToCart mutation.

Fields

Field NameDescription
cart - Cart!
The contents of the specified shopping cart.

Example

Copied to your clipboard
{"cart": Cart}

AreaInput

AreaInput defines the parameters which will be used for filter by specified location.

Input Fields

Input FieldDescription
radius - Int!
The radius for the search in KM.
search_term - String!
The country code where search must be performed. Required parameter together with region, city or postcode.

Example

Copied to your clipboard
{"radius": 987, "search_term": "abc123"}

AssignCompareListToCustomerOutput

Contains the results of the request to assign a compare list.

Fields

Field NameDescription
compare_list - CompareList
The contents of the customer's compare list.
result - Boolean!
Indicates whether the compare list was successfully assigned to the customer.

Example

Copied to your clipboard
{"compare_list": CompareList, "result": false}

Attribute

Contains details about the attribute, including the code and type.

Fields

Field NameDescription
attribute_code - String
The unique identifier for an attribute code. This value should be in lowercase letters without spaces.
attribute_options - [AttributeOption]
Attribute options list.
attribute_type - String
The data type of the attribute.
entity_type - String
The type of entity that defines the attribute.
input_type - String
The frontend input type of the attribute.
storefront_properties - StorefrontProperties
Details about the storefront properties configured for the attribute.

Example

Copied to your clipboard
{
  "attribute_code": "abc123",
  "attribute_options": [AttributeOption],
  "attribute_type": "abc123",
  "entity_type": "abc123",
  "input_type": "xyz789",
  "storefront_properties": StorefrontProperties
}

AttributeEntityTypeEnum

List of all entity types. Populated by the modules introducing EAV entities.

Values

Enum ValueDescription
CATALOG_PRODUCT
CATALOG_CATEGORY
CUSTOMER
CUSTOMER_ADDRESS
RMA_ITEM

Example

Copied to your clipboard
""CATALOG_PRODUCT""

AttributeFilterInput

An input object that specifies the filters used for attributes.

Input Fields

Input FieldDescription
is_comparable - Boolean
Whether a product or category attribute can be compared against another or not.
is_filterable - Boolean
Whether a product or category attribute can be filtered or not.
is_filterable_in_search - Boolean
Whether a product or category attribute can be filtered in search or not.
is_html_allowed_on_front - Boolean
Whether a product or category attribute can use HTML on front or not.
is_searchable - Boolean
Whether a product or category attribute can be searched or not.
is_used_for_customer_segment - Boolean
Whether a customer or customer address attribute is used for customer segment or not.
is_used_for_price_rules - Boolean
Whether a product or category attribute can be used for price rules or not.
is_used_for_promo_rules - Boolean
Whether a product or category attribute is used for promo rules or not.
is_visible_in_advanced_search - Boolean
Whether a product or category attribute is visible in advanced search or not.
is_visible_on_front - Boolean
Whether a product or category attribute is visible on front or not.
is_wysiwyg_enabled - Boolean
Whether a product or category attribute has WYSIWYG enabled or not.
used_in_product_listing - Boolean
Whether a product or category attribute is used in product listing or not.

Example

Copied to your clipboard
{
  "is_comparable": true,
  "is_filterable": true,
  "is_filterable_in_search": false,
  "is_html_allowed_on_front": false,
  "is_searchable": false,
  "is_used_for_customer_segment": false,
  "is_used_for_price_rules": true,
  "is_used_for_promo_rules": false,
  "is_visible_in_advanced_search": false,
  "is_visible_on_front": false,
  "is_wysiwyg_enabled": true,
  "used_in_product_listing": true
}

AttributeFrontendInputEnum

EAV attribute frontend input types.

Values

Enum ValueDescription
BOOLEAN
DATE
DATETIME
FILE
GALLERY
HIDDEN
IMAGE
MEDIA_IMAGE
MULTILINE
MULTISELECT
PRICE
SELECT
TEXT
TEXTAREA
WEIGHT
UNDEFINED

Example

Copied to your clipboard
""BOOLEAN""

AttributeInput

Defines the attribute characteristics to search for the attribute_code and entity_type to search.

Input Fields

Input FieldDescription
attribute_code - String
The unique identifier for an attribute code. This value should be in lowercase letters without spaces.
entity_type - String
The type of entity that defines the attribute.

Example

Copied to your clipboard
{
  "attribute_code": "abc123",
  "entity_type": "xyz789"
}

AttributeInputSelectedOption

Specifies selected option for a select or multiselect attribute value.

Input Fields

Input FieldDescription
value - String!
The attribute option value.

Example

Copied to your clipboard
{"value": "xyz789"}

AttributeMetadata

Base EAV implementation of CustomAttributeMetadataInterface.

Fields

Field NameDescription
code - ID!
The unique identifier for an attribute code. This value should be in lowercase letters without spaces.
default_value - String
Default attribute value.
entity_type - AttributeEntityTypeEnum!
The type of entity that defines the attribute.
frontend_class - String
The frontend class of the attribute.
frontend_input - AttributeFrontendInputEnum
The frontend input type of the attribute.
is_required - Boolean!
Whether the attribute value is required.
is_unique - Boolean!
Whether the attribute value must be unique.
label - String
The label assigned to the attribute.
options - [CustomAttributeOptionInterface]!
Attribute options.

Example

Copied to your clipboard
{
  "code": 4,
  "default_value": "xyz789",
  "entity_type": "CATALOG_PRODUCT",
  "frontend_class": "abc123",
  "frontend_input": "BOOLEAN",
  "is_required": true,
  "is_unique": false,
  "label": "xyz789",
  "options": [CustomAttributeOptionInterface]
}

AttributeMetadataError

Attribute metadata retrieval error.

Fields

Field NameDescription
message - String!
Attribute metadata retrieval error message.
type - AttributeMetadataErrorType!
Attribute metadata retrieval error type.

Example

Copied to your clipboard
{
  "message": "abc123",
  "type": "ENTITY_NOT_FOUND"
}

AttributeMetadataErrorType

Attribute metadata retrieval error types.

Values

Enum ValueDescription
ENTITY_NOT_FOUND
The requested entity was not found.
ATTRIBUTE_NOT_FOUND
The requested attribute was not found.
FILTER_NOT_FOUND
The filter cannot be applied as it does not belong to the entity
UNDEFINED
Not categorized error, see the error message.

Example

Copied to your clipboard
""ENTITY_NOT_FOUND""

AttributeOption

Defines an attribute option.

Fields

Field NameDescription
label - String
The label assigned to the attribute option.
value - String
The attribute option value.

Example

Copied to your clipboard
{
  "label": "abc123",
  "value": "xyz789"
}

AttributeOptionMetadata

Base EAV implementation of CustomAttributeOptionInterface.

Fields

Field NameDescription
is_default - Boolean!
Is the option value default.
label - String!
The label assigned to the attribute option.
value - String!
The attribute option value.

Example

Copied to your clipboard
{
  "is_default": false,
  "label": "abc123",
  "value": "xyz789"
}

AttributeSelectedOption

Fields

Field NameDescription
label - String!
The attribute selected option label.
value - String!
The attribute selected option value.

Example

Copied to your clipboard
{
  "label": "abc123",
  "value": "xyz789"
}

AttributeSelectedOptionInterface

Fields

Field NameDescription
label - String!
The attribute selected option label.
value - String!
The attribute selected option value.

Possible Types

AttributeSelectedOptionInterface Types
AttributeSelectedOption

Example

Copied to your clipboard
{
  "label": "abc123",
  "value": "abc123"
}

AttributeSelectedOptions

Fields

Field NameDescription
code - ID!
The attribute code.
selected_options - [AttributeSelectedOptionInterface]!

Example

Copied to your clipboard
{
  "code": 4,
  "selected_options": [AttributeSelectedOptionInterface]
}

AttributeValue

Fields

Field NameDescription
code - ID!
The attribute code.
value - String!
The attribute value.

Example

Copied to your clipboard
{
  "code": "4",
  "value": "xyz789"
}

AttributeValueInput

Specifies the value for attribute.

Input Fields

Input FieldDescription
attribute_code - String!
The code of the attribute.
selected_options - [AttributeInputSelectedOption]
An array containing selected options for a select or multiselect attribute.
value - String
The value assigned to the attribute.

Example

Copied to your clipboard
{
  "attribute_code": "xyz789",
  "selected_options": [AttributeInputSelectedOption],
  "value": "abc123"
}

AttributeValueInterface

Fields

Field NameDescription
code - ID!
The attribute code.

Possible Types

AttributeValueInterface Types
AttributeValue
AttributeSelectedOptions
GiftCartAttributeValue

Example

Copied to your clipboard
{"code": "4"}

AttributesFormOutput

Metadata of EAV attributes associated to form

Fields

Field NameDescription
errors - [AttributeMetadataError]!
Errors of retrieving certain attributes metadata.
items - [CustomAttributeMetadataInterface]!
Requested attributes metadata.

Example

Copied to your clipboard
{
  "errors": [AttributeMetadataError],
  "items": [CustomAttributeMetadataInterface]
}

AttributesMetadataOutput

Metadata of EAV attributes.

Fields

Field NameDescription
errors - [AttributeMetadataError]!
Errors of retrieving certain attributes metadata.
items - [CustomAttributeMetadataInterface]!
Requested attributes metadata.

Example

Copied to your clipboard
{
  "errors": [AttributeMetadataError],
  "items": [CustomAttributeMetadataInterface]
}

AvailableCurrency

Defines the code and symbol of a currency that can be used for purchase orders.

Fields

Field NameDescription
code - CurrencyEnum!
3-letter currency code, for example USD.
symbol - String!
Currency symbol, for example $.

Example

Copied to your clipboard
{"code": "AFN", "symbol": "xyz789"}

AvailablePaymentMethod

Describes a payment method that the shopper can use to pay for the order.

Fields

Field NameDescription
code - String!
The payment method code.
is_deferred - Boolean!
If the payment method is an online integration
title - String!
The payment method title.

Example

Copied to your clipboard
{
  "code": "abc123",
  "is_deferred": true,
  "title": "abc123"
}

AvailableShippingMethod

Contains details about the possible shipping methods and carriers.

Fields

Field NameDescription
amount - Money!
The cost of shipping using this shipping method.
available - Boolean!
Indicates whether this shipping method can be applied to the cart.
base_amount - Money
(Deprecated: The field should not be used on the storefront.)
carrier_code - String!
A string that identifies a commercial carrier or an offline shipping method.
carrier_title - String!
The label for the carrier code.
error_message - String
Describes an error condition.
method_code - String
A shipping method code associated with a carrier. The value could be null if no method is available.
method_title - String
The label for the shipping method code. The value could be null if no method is available.
price_excl_tax - Money!
The cost of shipping using this shipping method, excluding tax.
price_incl_tax - Money!
The cost of shipping using this shipping method, including tax.

Example

Copied to your clipboard
{
  "amount": Money,
  "available": false,
  "base_amount": Money,
  "carrier_code": "abc123",
  "carrier_title": "xyz789",
  "error_message": "xyz789",
  "method_code": "abc123",
  "method_title": "xyz789",
  "price_excl_tax": Money,
  "price_incl_tax": Money
}

BatchMutationStatus

Values

Enum ValueDescription
SUCCESS
FAILURE
MIXED_RESULTS

Example

Copied to your clipboard
""SUCCESS""

BillingAddressInput

Defines the billing address.

Input Fields

Input FieldDescription
address - CartAddressInput
Defines a billing address.
customer_address_id - Int
An ID from the customer's address book that uniquely identifies the address to be used for billing.
customer_address_uid - ID
The unique ID from the customer's address book that uniquely identifies the address to be used for billing.
same_as_shipping - Boolean
Indicates whether to set the billing address to be the same as the existing shipping address on the cart.
use_for_shipping - Boolean
Indicates whether to set the shipping address to be the same as this billing address.

Example

Copied to your clipboard
{
  "address": CartAddressInput,
  "customer_address_id": 123,
  "customer_address_uid": "4",
  "same_as_shipping": false,
  "use_for_shipping": true
}

BillingAddressPaymentSourceInput

The billing address information

Input Fields

Input FieldDescription
address_line_1 - String
The first line of the address
address_line_2 - String
The second line of the address
city - String
The city of the address
country_code - String!
The country of the address
postal_code - String
The postal code of the address
region - String
The region of the address

Example

Copied to your clipboard
{
  "address_line_1": "xyz789",
  "address_line_2": "xyz789",
  "city": "abc123",
  "country_code": "abc123",
  "postal_code": "xyz789",
  "region": "abc123"
}

BillingCartAddress

Contains details about the billing address.

Fields

Field NameDescription
city - String!
The city specified for the billing or shipping address.
company - String
The company specified for the billing or shipping address.
country - CartAddressCountry!
An object containing the country label and code.
custom_attributes - [AttributeValueInterface]!
The custom attribute values of the billing or shipping address.
customer_address_uid - ID
The unique ID from the customer's address book that uniquely identifies the address.
customer_notes - String
(Deprecated: The field is used only in shipping address.)
fax - String
The customer's fax number.
firstname - String!
The first name of the customer or guest.
id - Int
Id of the customer address. (Deprecated: Use `customer_address_uid` instead.)
lastname - String!
The last name of the customer or guest.
middlename - String
The middle name of the person associated with the billing/shipping address.
postcode - String
The ZIP or postal code of the billing or shipping address.
prefix - String
An honorific, such as Dr., Mr., or Mrs.
region - CartAddressRegion
An object containing the region label and code.
street - [String]!
An array containing the street for the billing or shipping address.
suffix - String
A value such as Sr., Jr., or III.
telephone - String
The telephone number for the billing or shipping address.
uid - ID!
The unique id of the customer cart address.
vat_id - String
The VAT company number for billing or shipping address.

Example

Copied to your clipboard
{
  "city": "xyz789",
  "company": "abc123",
  "country": CartAddressCountry,
  "custom_attributes": [AttributeValueInterface],
  "customer_address_uid": "4",
  "customer_notes": "abc123",
  "fax": "xyz789",
  "firstname": "abc123",
  "id": 987,
  "lastname": "abc123",
  "middlename": "xyz789",
  "postcode": "abc123",
  "prefix": "abc123",
  "region": CartAddressRegion,
  "street": ["abc123"],
  "suffix": "xyz789",
  "telephone": "abc123",
  "uid": 4,
  "vat_id": "xyz789"
}

Boolean

The Boolean scalar type represents true or false.

Example

Copied to your clipboard
true

BraintreeCcVaultInput

Input Fields

Input FieldDescription
device_data - String
public_hash - String!

Example

Copied to your clipboard
{
  "device_data": "abc123",
  "public_hash": "xyz789"
}

BraintreeInput

Input Fields

Input FieldDescription
device_data - String
Contains a fingerprint provided by Braintree JS SDK and should be sent with sale transaction details to the Braintree payment gateway.
is_active_payment_token_enabler - Boolean!
States whether the payment details (Credit/Debit Card, PayPal Account) entered by a customer should be tokenized for later usage. Required only if Vault is enabled for the relevant Braintree payment integration.
payment_method_nonce - String!
The one-time payment token generated by Braintree payment gateway based on payment details (Card, PayPal). Required field to make sale transaction.

Example

Copied to your clipboard
{
  "device_data": "xyz789",
  "is_active_payment_token_enabler": false,
  "payment_method_nonce": "xyz789"
}

BraintreeVaultInput

Input Fields

Input FieldDescription
device_data - String
public_hash - String!

Example

Copied to your clipboard
{
  "device_data": "abc123",
  "public_hash": "abc123"
}

Breadcrumb

Contains details about an individual category that comprises a breadcrumb.

Fields

Field NameDescription
category_id - Int
The ID of the category. (Deprecated: Use `category_uid` instead.)
category_level - Int
The category level.
category_name - String
The display name of the category.
category_uid - ID!
The unique ID for a `Breadcrumb` object.
category_url_key - String
The URL key of the category.
category_url_path - String
The URL path of the category.

Example

Copied to your clipboard
{
  "category_id": 987,
  "category_level": 123,
  "category_name": "xyz789",
  "category_uid": "4",
  "category_url_key": "xyz789",
  "category_url_path": "abc123"
}

BundleCartItem

An implementation for bundle product cart items.

Fields

Field NameDescription
available_gift_wrapping - [GiftWrapping]!
The list of available gift wrapping options for the cart item.
bundle_options - [SelectedBundleOption]!
An array containing the bundle options the shopper selected.
customizable_options - [SelectedCustomizableOption]!
An array containing the customizable options the shopper selected.
discount - [Discount]
Contains discount for quote line item.
errors - [CartItemError]
An array of errors encountered while loading the cart item
gift_message - GiftMessage
The entered gift message for the cart item
gift_wrapping - GiftWrapping
The selected gift wrapping for the cart item.
id - String!
(Deprecated: Use `uid` instead.)
is_available - Boolean!
True if requested quantity is less than available stock, false otherwise.
max_qty - Float
Line item max qty in quote template
min_qty - Float
Line item min qty in quote template
not_available_message - String
Message to display when the product is not available with this selected option.
note_from_buyer - [ItemNote]
The buyer's quote line item note.
note_from_seller - [ItemNote]
The seller's quote line item note.
prices - CartItemPrices
Contains details about the price of the item, including taxes and discounts.
product - ProductInterface!
Details about an item in the cart.
quantity - Float!
The quantity of this item in the cart.
uid - ID!
The unique ID for a `CartItemInterface` object.

Example

Copied to your clipboard
{
  "available_gift_wrapping": [GiftWrapping],
  "bundle_options": [SelectedBundleOption],
  "customizable_options": [SelectedCustomizableOption],
  "discount": [Discount],
  "errors": [CartItemError],
  "gift_message": GiftMessage,
  "gift_wrapping": GiftWrapping,
  "id": "abc123",
  "is_available": true,
  "max_qty": 123.45,
  "min_qty": 987.65,
  "not_available_message": "xyz789",
  "note_from_buyer": [ItemNote],
  "note_from_seller": [ItemNote],
  "prices": CartItemPrices,
  "product": ProductInterface,
  "quantity": 123.45,
  "uid": 4
}

BundleCreditMemoItem

Defines bundle product options for CreditMemoItemInterface.

Fields

Field NameDescription
bundle_options - [ItemSelectedBundleOption]
A list of bundle options that are assigned to a bundle product that is part of a credit memo.
discounts - [Discount]
Details about the final discount amount for the base product, including discounts on options.
id - ID!
The unique ID for a `CreditMemoItemInterface` object.
order_item - OrderItemInterface
The order item the credit memo is applied to.
product_name - String
The name of the base product.
product_sale_price - Money!
The sale price for the base product, including selected options.
product_sku - String!
The SKU of the base product.
quantity_refunded - Float
The number of refunded items.

Example

Copied to your clipboard
{
  "bundle_options": [ItemSelectedBundleOption],
  "discounts": [Discount],
  "id": 4,
  "order_item": OrderItemInterface,
  "product_name": "xyz789",
  "product_sale_price": Money,
  "product_sku": "xyz789",
  "quantity_refunded": 987.65
}

BundleInvoiceItem

Defines bundle product options for InvoiceItemInterface.

Fields

Field NameDescription
bundle_options - [ItemSelectedBundleOption]
A list of bundle options that are assigned to an invoiced bundle product.
discounts - [Discount]
Information about the final discount amount for the base product, including discounts on options.
id - ID!
The unique ID for an `InvoiceItemInterface` object.
order_item - OrderItemInterface
Details about an individual order item.
product_name - String
The name of the base product.
product_sale_price - Money!
The sale price for the base product including selected options.
product_sku - String!
The SKU of the base product.
quantity_invoiced - Float
The number of invoiced items.

Example

Copied to your clipboard
{
  "bundle_options": [ItemSelectedBundleOption],
  "discounts": [Discount],
  "id": "4",
  "order_item": OrderItemInterface,
  "product_name": "abc123",
  "product_sale_price": Money,
  "product_sku": "xyz789",
  "quantity_invoiced": 123.45
}

BundleItem

Defines an individual item within a bundle product.

Fields

Field NameDescription
option_id - Int
An ID assigned to each type of item in a bundle product. (Deprecated: Use `uid` instead)
options - [BundleItemOption]
An array of additional options for this bundle item.
position - Int
A number indicating the sequence order of this item compared to the other bundle items.
price_range - PriceRange!
The range of prices for the product
required - Boolean
Indicates whether the item must be included in the bundle.
sku - String
The SKU of the bundle product.
title - String
The display name of the item.
type - String
The input type that the customer uses to select the item. Examples include radio button and checkbox.
uid - ID
The unique ID for a `BundleItem` object.

Example

Copied to your clipboard
{
  "option_id": 123,
  "options": [BundleItemOption],
  "position": 123,
  "price_range": PriceRange,
  "required": false,
  "sku": "xyz789",
  "title": "abc123",
  "type": "xyz789",
  "uid": 4
}

BundleItemOption

Defines the characteristics that comprise a specific bundle item and its options.

Fields

Field NameDescription
can_change_quantity - Boolean
Indicates whether the customer can change the number of items for this option.
id - Int
The ID assigned to the bundled item option. (Deprecated: Use `uid` instead)
is_default - Boolean
Indicates whether this option is the default option.
label - String
The text that identifies the bundled item option.
position - Int
When a bundle item contains multiple options, the relative position of this option compared to the other options.
price - Float
The price of the selected option.
price_type - PriceTypeEnum
One of FIXED, PERCENT, or DYNAMIC.
product - ProductInterface
Contains details about this product option.
qty - Float
Indicates the quantity of this specific bundle item. (Deprecated: Use `quantity` instead.)
quantity - Float
The quantity of this specific bundle item.
uid - ID!
The unique ID for a `BundleItemOption` object.

Example

Copied to your clipboard
{
  "can_change_quantity": false,
  "id": 987,
  "is_default": true,
  "label": "xyz789",
  "position": 987,
  "price": 123.45,
  "price_type": "FIXED",
  "product": ProductInterface,
  "qty": 987.65,
  "quantity": 987.65,
  "uid": 4
}

BundleOptionInput

Defines the input for a bundle option.

Input Fields

Input FieldDescription
id - Int!
The ID of the option.
quantity - Float!
The number of the selected item to add to the cart.
value - [String]!
An array with the chosen value of the option.

Example

Copied to your clipboard
{
  "id": 123,
  "quantity": 987.65,
  "value": ["abc123"]
}

BundleOrderItem

Defines bundle product options for OrderItemInterface.

Fields

Field NameDescription
bundle_options - [ItemSelectedBundleOption]
A list of bundle options that are assigned to the bundle product.
discounts - [Discount]
The final discount information for the product.
eligible_for_return - Boolean
Indicates whether the order item is eligible to be in a return request.
entered_options - [OrderItemOption]
The entered option for the base product, such as a logo or image.
gift_message - GiftMessage
The selected gift message for the order item
gift_wrapping - GiftWrapping
The selected gift wrapping for the order item.
id - ID!
The unique ID for an `OrderItemInterface` object.
parent_sku - String
The SKU of parent product.
prices - OrderItemPrices
Contains details about the price of the item, including taxes and discounts.
product - ProductInterface
The ProductInterface object, which contains details about the base product
product_name - String
The name of the base product.
product_sale_price - Money!
The sale price of the base product, including selected options.
product_sku - String!
The SKU of the base product.
product_type - String
The type of product, such as simple, configurable, etc.
product_url_key - String
URL key of the base product.
quantity_canceled - Float
The number of canceled items.
quantity_invoiced - Float
The number of invoiced items.
quantity_ordered - Float
The number of units ordered for this item.
quantity_refunded - Float
The number of refunded items.
quantity_return_requested - Float
The requested return quantity of the item.
quantity_returned - Float
The number of returned items.
quantity_shipped - Float
The number of shipped items.
selected_options - [OrderItemOption]
The selected options for the base product, such as color or size.
status - String
The status of the order item.

Example

Copied to your clipboard
{
  "bundle_options": [ItemSelectedBundleOption],
  "discounts": [Discount],
  "eligible_for_return": true,
  "entered_options": [OrderItemOption],
  "gift_message": GiftMessage,
  "gift_wrapping": GiftWrapping,
  "id": "4",
  "parent_sku": "xyz789",
  "prices": OrderItemPrices,
  "product": ProductInterface,
  "product_name": "xyz789",
  "product_sale_price": Money,
  "product_sku": "abc123",
  "product_type": "abc123",
  "product_url_key": "abc123",
  "quantity_canceled": 987.65,
  "quantity_invoiced": 123.45,
  "quantity_ordered": 123.45,
  "quantity_refunded": 123.45,
  "quantity_return_requested": 987.65,
  "quantity_returned": 987.65,
  "quantity_shipped": 123.45,
  "selected_options": [OrderItemOption],
  "status": "xyz789"
}

BundleProduct

Defines basic features of a bundle product and contains multiple BundleItems.

Fields

Field NameDescription
attribute_set_id - Int
The attribute set assigned to the product. (Deprecated: The field should not be used on the storefront.)
canonical_url - String
The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.
categories - [CategoryInterface]
The categories assigned to a product.
color - Int
(Deprecated: Use the `custom_attributes` field instead.)
country_of_manufacture - String
The product's country of origin.
created_at - String
Timestamp indicating when the product was created. (Deprecated: The field should not be used on the storefront.)
crosssell_products - [ProductInterface]
An array of cross-sell products.
custom_attributesV2 - ProductCustomAttributes
Product custom attributes.
description - ComplexTextValue
Detailed information about the product. The value can include simple HTML tags.
dynamic_price - Boolean
Indicates whether the bundle product has a dynamic price.
dynamic_sku - Boolean
Indicates whether the bundle product has a dynamic SKU.
dynamic_weight - Boolean
Indicates whether the bundle product has a dynamically calculated weight.
gift_message_available - Boolean!
Returns a value indicating gift message availability for the product.
gift_wrapping_available - Boolean!
Returns a value indicating gift wrapping availability for the product.
gift_wrapping_price - Money
Returns value and currency indicating gift wrapping price for the product.
id - Int
The ID number assigned to the product. (Deprecated: Use the `uid` field instead.)
image - ProductImage
The relative path to the main image on the product page.
is_returnable - String
Indicates whether the product can be returned.
items - [BundleItem]
An array containing information about individual bundle items.
manufacturer - Int
A number representing the product's manufacturer. (Deprecated: Use the `custom_attributes` field instead.)
max_sale_qty - Float
Maximum Qty Allowed in Shopping Cart
media_gallery - [MediaGalleryInterface]
An array of media gallery objects.
media_gallery_entries - [MediaGalleryEntry]
An array of MediaGalleryEntry objects. (Deprecated: Use `media_gallery` instead.)
meta_description - String
A brief overview of the product for search results listings, maximum 255 characters.
meta_keyword - String
A comma-separated list of keywords that are visible only to search engines.
meta_title - String
A string that is displayed in the title bar and tab of the browser and in search results lists.
min_sale_qty - Float
Minimum Qty Allowed in Shopping Cart
name - String
The product name. Customers use this name to identify the product.
new_from_date - String
The beginning date for new product listings, and determines if the product is featured as a new product.
new_to_date - String
The end date for new product listings.
only_x_left_in_stock - Float
Product stock only x left count
options - [CustomizableOptionInterface]
An array of options for a customizable product.
options_container - String
If the product has multiple options, determines where they appear on the product page.
price - ProductPrices
Indicates the price of an item. (Deprecated: Use `price_range` for product price information.)
price_details - PriceDetails
The price details of the main product
price_range - PriceRange!
The range of prices for the product
price_tiers - [TierPrice]
An array of `TierPrice` objects.
price_view - PriceViewEnum
One of PRICE_RANGE or AS_LOW_AS.
product_links - [ProductLinksInterface]
An array of `ProductLinks` objects.
quantity - Float
Amount of available stock
rating_summary - Float!
The average of all the ratings given to the product.
redirect_code - Int!
Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.
related_products - [ProductInterface]
An array of related products.
relative_url - String
The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.
review_count - Int!
The total count of all the reviews given to the product.
reviews - ProductReviews!
The list of products reviews.
ship_bundle_items - ShipBundleItemsEnum
Indicates whether to ship bundle items together or individually.
short_description - ComplexTextValue
A short description of the product. Its use depends on the theme.
sku - String
A number or code assigned to a product to identify the product, options, price, and manufacturer.
small_image - ProductImage
The relative path to the small image, which is used on catalog pages.
special_from_date - String
The beginning date that a product has a special price. (Deprecated: The field should not be used on the storefront.)
special_price - Float
The discounted price of the product.
special_to_date - String
The end date for a product with a special price.
staged - Boolean!
Indicates whether the product is staged for a future campaign.
stock_status - ProductStockStatus
Stock status of the product
swatch_image - String
The file name of a swatch image.
thumbnail - ProductImage
The relative path to the product's thumbnail image.
tier_price - Float
The price when tier pricing is in effect and the items purchased threshold has been reached. (Deprecated: Use `price_tiers` for product tier price information.)
tier_prices - [ProductTierPrices]
An array of ProductTierPrices objects. (Deprecated: Use `price_tiers` for product tier price information.)
type - UrlRewriteEntityTypeEnum
One of PRODUCT, CATEGORY, or CMS_PAGE.
type_id - String
One of simple, virtual, bundle, downloadable, grouped, or configurable. (Deprecated: Use `__typename` instead.)
uid - ID!
The unique ID for a `ProductInterface` object.
updated_at - String
Timestamp indicating when the product was updated. (Deprecated: The field should not be used on the storefront.)
upsell_products - [ProductInterface]
An array of up-sell products.
url_key - String
The part of the URL that identifies the product
url_path - String
(Deprecated: Use product's `canonical_url` or url rewrites instead)
url_rewrites - [UrlRewrite]
URL rewrites list
url_suffix - String
The part of the product URL that is appended after the url key
websites - [Website]
An array of websites in which the product is available. (Deprecated: The field should not be used on the storefront.)
weight - Float
The weight of the item, in units defined by the store.

Example

Copied to your clipboard
{
  "attribute_set_id": 123,
  "canonical_url": "abc123",
  "categories": [CategoryInterface],
  "color": 987,
  "country_of_manufacture": "xyz789",
  "created_at": "xyz789",
  "crosssell_products": [ProductInterface],
  "custom_attributesV2": ProductCustomAttributes,
  "description": ComplexTextValue,
  "dynamic_price": true,
  "dynamic_sku": true,
  "dynamic_weight": false,
  "gift_message_available": true,
  "gift_wrapping_available": true,
  "gift_wrapping_price": Money,
  "id": 123,
  "image": ProductImage,
  "is_returnable": "abc123",
  "items": [BundleItem],
  "manufacturer": 987,
  "max_sale_qty": 987.65,
  "media_gallery": [MediaGalleryInterface],
  "media_gallery_entries": [MediaGalleryEntry],
  "meta_description": "xyz789",
  "meta_keyword": "abc123",
  "meta_title": "abc123",
  "min_sale_qty": 123.45,
  "name": "abc123",
  "new_from_date": "xyz789",
  "new_to_date": "abc123",
  "only_x_left_in_stock": 123.45,
  "options": [CustomizableOptionInterface],
  "options_container": "xyz789",
  "price": ProductPrices,
  "price_details": PriceDetails,
  "price_range": PriceRange,
  "price_tiers": [TierPrice],
  "price_view": "PRICE_RANGE",
  "product_links": [ProductLinksInterface],
  "quantity": 123.45,
  "rating_summary": 987.65,
  "redirect_code": 987,
  "related_products": [ProductInterface],
  "relative_url": "abc123",
  "review_count": 123,
  "reviews": ProductReviews,
  "ship_bundle_items": "TOGETHER",
  "short_description": ComplexTextValue,
  "sku": "xyz789",
  "small_image": ProductImage,
  "special_from_date": "abc123",
  "special_price": 123.45,
  "special_to_date": "xyz789",
  "staged": false,
  "stock_status": "IN_STOCK",
  "swatch_image": "abc123",
  "thumbnail": ProductImage,
  "tier_price": 123.45,
  "tier_prices": [ProductTierPrices],
  "type": "CMS_PAGE",
  "type_id": "abc123",
  "uid": 4,
  "updated_at": "abc123",
  "upsell_products": [ProductInterface],
  "url_key": "abc123",
  "url_path": "xyz789",
  "url_rewrites": [UrlRewrite],
  "url_suffix": "abc123",
  "websites": [Website],
  "weight": 123.45
}

BundleProductCartItemInput

Defines a single bundle product.

Input Fields

Input FieldDescription
bundle_options - [BundleOptionInput]!
A mandatory array of options for the bundle product, including each chosen option and specified quantity.
customizable_options - [CustomizableOptionInput]
The ID and value of the option.
data - CartItemInput!
The quantity and SKU of the bundle product.

Example

Copied to your clipboard
{
  "bundle_options": [BundleOptionInput],
  "customizable_options": [CustomizableOptionInput],
  "data": CartItemInput
}

BundleRequisitionListItem

Contains details about bundle products added to a requisition list.

Fields

Field NameDescription
bundle_options - [SelectedBundleOption]!
An array of selected options for a bundle product.
customizable_options - [SelectedCustomizableOption]!
Selected custom options for an item in the requisition list.
product - ProductInterface!
Details about a requisition list item.
quantity - Float!
The quantity of the product added to the requisition list.
uid - ID!
The unique ID of an item in a requisition list.

Example

Copied to your clipboard
{
  "bundle_options": [SelectedBundleOption],
  "customizable_options": [SelectedCustomizableOption],
  "product": ProductInterface,
  "quantity": 987.65,
  "uid": 4
}

BundleShipmentItem

Defines bundle product options for ShipmentItemInterface.

Fields

Field NameDescription
bundle_options - [ItemSelectedBundleOption]
A list of bundle options that are assigned to a shipped product.
id - ID!
The unique ID for a `ShipmentItemInterface` object.
order_item - OrderItemInterface
The order item associated with the shipment item.
product_name - String
The name of the base product.
product_sale_price - Money!
The sale price for the base product.
product_sku - String!
The SKU of the base product.
quantity_shipped - Float!
The number of shipped items.

Example

Copied to your clipboard
{
  "bundle_options": [ItemSelectedBundleOption],
  "id": 4,
  "order_item": OrderItemInterface,
  "product_name": "abc123",
  "product_sale_price": Money,
  "product_sku": "xyz789",
  "quantity_shipped": 123.45
}

BundleWishlistItem

Defines bundle product options for WishlistItemInterface.

Fields

Field NameDescription
added_at - String!
The date and time the item was added to the wish list.
bundle_options - [SelectedBundleOption]
An array containing information about the selected bundle items.
customizable_options - [SelectedCustomizableOption]!
Custom options selected for the wish list item.
description - String
The description of the item.
id - ID!
The unique ID for a `WishlistItemInterface` object.
product - ProductInterface
Product details of the wish list item.
quantity - Float!
The quantity of this wish list item.

Example

Copied to your clipboard
{
  "added_at": "abc123",
  "bundle_options": [SelectedBundleOption],
  "customizable_options": [SelectedCustomizableOption],
  "description": "abc123",
  "id": "4",
  "product": ProductInterface,
  "quantity": 987.65
}

ButtonStyles

Fields

Field NameDescription
color - String
The button color
height - Int
The button height in pixels
label - String
The button label
layout - String
The button layout
shape - String
The button shape
tagline - Boolean
Indicates whether the tagline is displayed
use_default_height - Boolean
Defines if the button uses default height. If the value is false, the value of height is used

Example

Copied to your clipboard
{
  "color": "abc123",
  "height": 123,
  "label": "abc123",
  "layout": "abc123",
  "shape": "abc123",
  "tagline": true,
  "use_default_height": true
}

CancelNegotiableQuoteTemplateInput

Specifies the quote template id of the quote template to cancel

Input Fields

Input FieldDescription
cancellation_comment - String
A comment to provide reason of cancellation.
template_id - ID!
The unique ID of a `NegotiableQuoteTemplate` object.

Example

Copied to your clipboard
{
  "cancellation_comment": "xyz789",
  "template_id": "4"
}

CancelOrderError

Fields

Field NameDescription
code - CancelOrderErrorCode!
An error code that is specific to cancel order.
message - String!
A localized error message.

Example

Copied to your clipboard
{
  "code": "ORDER_CANCELLATION_DISABLED",
  "message": "abc123"
}

CancelOrderErrorCode

Values

Enum ValueDescription
ORDER_CANCELLATION_DISABLED
UNDEFINED
UNAUTHORISED
ORDER_NOT_FOUND
PARTIAL_ORDER_ITEM_SHIPPED
INVALID_ORDER_STATUS

Example

Copied to your clipboard
""ORDER_CANCELLATION_DISABLED""

CancelOrderInput

Defines the order to cancel.

Input Fields

Input FieldDescription
order_id - ID!
The unique ID of an `Order` type.
reason - String!
Cancellation reason.

Example

Copied to your clipboard
{"order_id": 4, "reason": "abc123"}

CancelOrderOutput

Contains the updated customer order and error message if any.

Fields

Field NameDescription
error - String
Error encountered while cancelling the order.
errorV2 - CancelOrderError
order - CustomerOrder
Updated customer order.

Example

Copied to your clipboard
{
  "error": "xyz789",
  "errorV2": CancelOrderError,
  "order": CustomerOrder
}

CancellationReason

Fields

Field NameDescription
description - String!

Example

Copied to your clipboard
{"description": "xyz789"}

Card

Fields

Field NameDescription
bin_details - CardBin
Card bin details
card_expiry_month - String
Expiration month of the card
card_expiry_year - String
Expiration year of the card
last_digits - String
Last four digits of the card
name - String
Name on the card

Example

Copied to your clipboard
{
  "bin_details": CardBin,
  "card_expiry_month": "xyz789",
  "card_expiry_year": "xyz789",
  "last_digits": "abc123",
  "name": "xyz789"
}

CardBin

Fields

Field NameDescription
bin - String
Card bin number

Example

Copied to your clipboard
{"bin": "xyz789"}

CardPaymentSourceInput

The card payment source information

Input Fields

Input FieldDescription
billing_address - BillingAddressPaymentSourceInput!
The billing address of the card
name - String
The name on the cardholder

Example

Copied to your clipboard
{
  "billing_address": BillingAddressPaymentSourceInput,
  "name": "xyz789"
}

CardPaymentSourceOutput

The card payment source information

Fields

Field NameDescription
brand - String
The brand of the card
expiry - String
The expiry of the card
last_digits - String
The last digits of the card

Example

Copied to your clipboard
{
  "brand": "abc123",
  "expiry": "xyz789",
  "last_digits": "xyz789"
}

Cart

Contains the contents and other details about a guest or customer cart.

Fields

Field NameDescription
applied_coupon - AppliedCoupon
(Deprecated: Use `applied_coupons` instead.)
applied_coupons - [AppliedCoupon]
An array of `AppliedCoupon` objects. Each object contains the `code` text attribute, which specifies the coupon code.
applied_gift_cards - [AppliedGiftCard]
An array of gift card items applied to the cart.
applied_reward_points - RewardPointsAmount
The amount of reward points applied to the cart.
applied_store_credit - AppliedStoreCredit
Store credit information applied to the cart.
available_gift_wrappings - [GiftWrapping]!
The list of available gift wrapping options for the cart.
available_payment_methods - [AvailablePaymentMethod]
An array of available payment methods.
billing_address - BillingCartAddress
The billing address assigned to the cart.
email - String
The email address of the guest or customer.
gift_message - GiftMessage
The entered gift message for the cart
gift_receipt_included - Boolean!
Indicates whether the shopper requested gift receipt for the cart.
gift_wrapping - GiftWrapping
The selected gift wrapping for the cart.
id - ID!
The unique ID for a `Cart` object.
is_virtual - Boolean!
Indicates whether the cart contains only virtual products.
items - [CartItemInterface]
An array of products that have been added to the cart. (Deprecated: Use `itemsV2` instead.)
itemsV2 - CartItems
prices - CartPrices
Pricing details for the quote.
printed_card_included - Boolean!
Indicates whether the shopper requested a printed card for the cart.
rules - [CartRuleStorefront]
Provides applied cart rules in the current active cart
selected_payment_method - SelectedPaymentMethod
Indicates which payment method was applied to the cart.
shipping_addresses - [ShippingCartAddress]!
An array of shipping addresses assigned to the cart.
total_quantity - Float!
The total number of items in the cart.

Example

Copied to your clipboard
{
  "applied_coupon": AppliedCoupon,
  "applied_coupons": [AppliedCoupon],
  "applied_gift_cards": [AppliedGiftCard],
  "applied_reward_points": RewardPointsAmount,
  "applied_store_credit": AppliedStoreCredit,
  "available_gift_wrappings": [GiftWrapping],
  "available_payment_methods": [AvailablePaymentMethod],
  "billing_address": BillingCartAddress,
  "email": "abc123",
  "gift_message": GiftMessage,
  "gift_receipt_included": false,
  "gift_wrapping": GiftWrapping,
  "id": 4,
  "is_virtual": false,
  "items": [CartItemInterface],
  "itemsV2": CartItems,
  "prices": CartPrices,
  "printed_card_included": true,
  "rules": [CartRuleStorefront],
  "selected_payment_method": SelectedPaymentMethod,
  "shipping_addresses": [ShippingCartAddress],
  "total_quantity": 987.65
}

CartAddressCountry

Contains details the country in a billing or shipping address.

Fields

Field NameDescription
code - String!
The country code.
label - String!
The display label for the country.

Example

Copied to your clipboard
{
  "code": "abc123",
  "label": "abc123"
}

CartAddressInput

Defines the billing or shipping address to be applied to the cart.

Input Fields

Input FieldDescription
city - String!
The city specified for the billing or shipping address.
company - String
The company specified for the billing or shipping address.
country_code - String!
The country code and label for the billing or shipping address.
custom_attributes - [AttributeValueInput]
The custom attribute values of the billing or shipping address.
fax - String
The customer's fax number.
firstname - String!
The first name of the customer or guest.
lastname - String!
The last name of the customer or guest.
middlename - String
The middle name of the person associated with the billing/shipping address.
postcode - String
The ZIP or postal code of the billing or shipping address.
prefix - String
An honorific, such as Dr., Mr., or Mrs.
region - String
A string that defines the state or province of the billing or shipping address.
region_id - Int
An integer that defines the state or province of the billing or shipping address.
save_in_address_book - Boolean
Determines whether to save the address in the customer's address book. The default value is true.
street - [String]!
An array containing the street for the billing or shipping address.
suffix - String
A value such as Sr., Jr., or III.
telephone - String!
The telephone number for the billing or shipping address.
vat_id - String
The VAT company number for billing or shipping address.

Example

Copied to your clipboard
{
  "city": "xyz789",
  "company": "xyz789",
  "country_code": "abc123",
  "custom_attributes": [AttributeValueInput],
  "fax": "abc123",
  "firstname": "xyz789",
  "lastname": "abc123",
  "middlename": "xyz789",
  "postcode": "xyz789",
  "prefix": "abc123",
  "region": "xyz789",
  "region_id": 987,
  "save_in_address_book": false,
  "street": ["abc123"],
  "suffix": "xyz789",
  "telephone": "abc123",
  "vat_id": "abc123"
}

CartAddressInterface

Fields

Field NameDescription
city - String!
The city specified for the billing or shipping address.
company - String
The company specified for the billing or shipping address.
country - CartAddressCountry!
An object containing the country label and code.
custom_attributes - [AttributeValueInterface]!
The custom attribute values of the billing or shipping address.
customer_address_uid - ID
The unique ID from the customer's address book that uniquely identifies the address.
fax - String
The customer's fax number.
firstname - String!
The first name of the customer or guest.
id - Int
Id of the customer address. (Deprecated: Use `customer_address_uid` instead.)
lastname - String!
The last name of the customer or guest.
middlename - String
The middle name of the person associated with the billing/shipping address.
postcode - String
The ZIP or postal code of the billing or shipping address.
prefix - String
An honorific, such as Dr., Mr., or Mrs.
region - CartAddressRegion
An object containing the region label and code.
street - [String]!
An array containing the street for the billing or shipping address.
suffix - String
A value such as Sr., Jr., or III.
telephone - String
The telephone number for the billing or shipping address.
uid - ID!
The unique id of the customer cart address.
vat_id - String
The VAT company number for billing or shipping address.

Possible Types

CartAddressInterface Types
ShippingCartAddress
BillingCartAddress

Example

Copied to your clipboard
{
  "city": "xyz789",
  "company": "xyz789",
  "country": CartAddressCountry,
  "custom_attributes": [AttributeValueInterface],
  "customer_address_uid": "4",
  "fax": "abc123",
  "firstname": "xyz789",
  "id": 123,
  "lastname": "abc123",
  "middlename": "abc123",
  "postcode": "abc123",
  "prefix": "xyz789",
  "region": CartAddressRegion,
  "street": ["xyz789"],
  "suffix": "xyz789",
  "telephone": "abc123",
  "uid": "4",
  "vat_id": "abc123"
}

CartAddressRegion

Contains details about the region in a billing or shipping address.

Fields

Field NameDescription
code - String
The state or province code.
label - String
The display label for the region.
region_id - Int
The unique ID for a pre-defined region.

Example

Copied to your clipboard
{
  "code": "abc123",
  "label": "abc123",
  "region_id": 987
}

CartDiscount

Contains information about discounts applied to the cart.

Fields

Field NameDescription
amount - Money!
The amount of the discount applied to the item.
label - [String]!
The description of the discount.

Example

Copied to your clipboard
{
  "amount": Money,
  "label": ["abc123"]
}

CartDiscountType

Values

Enum ValueDescription
ITEM
SHIPPING

Example

Copied to your clipboard
""ITEM""

CartItemError

Fields

Field NameDescription
code - CartItemErrorType!
An error code that describes the error encountered
message - String!
A localized error message

Example

Copied to your clipboard
{"code": "UNDEFINED", "message": "abc123"}

CartItemErrorType

Values

Enum ValueDescription
UNDEFINED
ITEM_QTY
ITEM_INCREMENTS

Example

Copied to your clipboard
""UNDEFINED""

CartItemInput

Defines an item to be added to the cart.

Input Fields

Input FieldDescription
entered_options - [EnteredOptionInput]
An array of entered options for the base product, such as personalization text.
parent_sku - String
For a child product, the SKU of its parent product.
quantity - Float!
The amount or number of an item to add.
selected_options - [ID]
The selected options for the base product, such as color or size, using the unique ID for an object such as `CustomizableRadioOption`, `CustomizableDropDownOption`, or `ConfigurableProductOptionsValues`.
sku - String!
The SKU of the product.

Example

Copied to your clipboard
{
  "entered_options": [EnteredOptionInput],
  "parent_sku": "abc123",
  "quantity": 987.65,
  "selected_options": ["4"],
  "sku": "abc123"
}

CartItemInterface

An interface for products in a cart.

Fields

Field NameDescription
discount - [Discount]
Contains discount for quote line item.
errors - [CartItemError]
An array of errors encountered while loading the cart item
id - String!
(Deprecated: Use `uid` instead.)
is_available - Boolean!
True if requested quantity is less than available stock, false otherwise.
max_qty - Float
Line item max qty in quote template
min_qty - Float
Line item min qty in quote template
not_available_message - String
Message to display when the product is not available with this selected option.
note_from_buyer - [ItemNote]
The buyer's quote line item note.
note_from_seller - [ItemNote]
The seller's quote line item note.
prices - CartItemPrices
Contains details about the price of the item, including taxes and discounts.
product - ProductInterface!
Details about an item in the cart.
quantity - Float!
The quantity of this item in the cart.
uid - ID!
The unique ID for a `CartItemInterface` object.

Possible Types

CartItemInterface Types
SimpleCartItem
VirtualCartItem
ConfigurableCartItem
DownloadableCartItem
BundleCartItem
GiftCardCartItem

Example

Copied to your clipboard
{
  "discount": [Discount],
  "errors": [CartItemError],
  "id": "abc123",
  "is_available": true,
  "max_qty": 987.65,
  "min_qty": 123.45,
  "not_available_message": "xyz789",
  "note_from_buyer": [ItemNote],
  "note_from_seller": [ItemNote],
  "prices": CartItemPrices,
  "product": ProductInterface,
  "quantity": 123.45,
  "uid": 4
}

CartItemPrices

Contains details about the price of the item, including taxes and discounts.

Fields

Field NameDescription
catalog_discount - ProductDiscount
The price discount for the unit price of the item represents the difference between its regular price and final price.
discounts - [Discount]
An array of discounts to be applied to the cart item.
fixed_product_taxes - [FixedProductTax]
An array of FPTs applied to the cart item.
original_item_price - Money!
The value of the original unit price for the item, including discounts.
original_row_total - Money!
The value of the original price multiplied by the quantity of the item.
price - Money!
The price of the item before any discounts were applied. The price that might include tax, depending on the configured display settings for cart.
price_including_tax - Money!
The price of the item before any discounts were applied. The price that might include tax, depending on the configured display settings for cart.
row_catalog_discount - ProductDiscount
The price discount multiplied by the item quantity represents the total difference between the regular price and the final price for the entire quote item.
row_total - Money!
The value of the price multiplied by the quantity of the item.
row_total_including_tax - Money!
The value of `row_total` plus the tax applied to the item.
total_item_discount - Money
The total of all discounts applied to the item.

Example

Copied to your clipboard
{
  "catalog_discount": ProductDiscount,
  "discounts": [Discount],
  "fixed_product_taxes": [FixedProductTax],
  "original_item_price": Money,
  "original_row_total": Money,
  "price": Money,
  "price_including_tax": Money,
  "row_catalog_discount": ProductDiscount,
  "row_total": Money,
  "row_total_including_tax": Money,
  "total_item_discount": Money
}

CartItemQuantity

Deprecated: The ShippingCartAddress.cart_items field now returns CartItemInterface.

Fields

Field NameDescription
cart_item_id - Int!
(Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`.)
quantity - Float!
(Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`.)

Example

Copied to your clipboard
{"cart_item_id": 987, "quantity": 123.45}

CartItemSelectedOptionValuePrice

Contains details about the price of a selected customizable value.

Fields

Field NameDescription
type - PriceTypeEnum!
Indicates whether the price type is fixed, percent, or dynamic.
units - String!
A string that describes the unit of the value.
value - Float!
A price value.

Example

Copied to your clipboard
{
  "type": "FIXED",
  "units": "abc123",
  "value": 987.65
}

CartItemUpdateInput

A single item to be updated.

Input Fields

Input FieldDescription
cart_item_id - Int
Deprecated. Use `cart_item_uid` instead.
cart_item_uid - ID
The unique ID for a `CartItemInterface` object.
customizable_options - [CustomizableOptionInput]
An array that defines customizable options for the product.
gift_message - GiftMessageInput
Gift message details for the cart item
gift_wrapping_id - ID
The unique ID for a `GiftWrapping` object to be used for the cart item.
quantity - Float
The new quantity of the item.

Example

Copied to your clipboard
{
  "cart_item_id": 987,
  "cart_item_uid": "4",
  "customizable_options": [CustomizableOptionInput],
  "gift_message": GiftMessageInput,
  "gift_wrapping_id": 4,
  "quantity": 987.65
}

CartItems

Fields

Field NameDescription
items - [CartItemInterface]!
An array of products that have been added to the cart.
page_info - SearchResultPageInfo
Metadata for pagination rendering.
total_count - Int!
The number of returned cart items.

Example

Copied to your clipboard
{
  "items": [CartItemInterface],
  "page_info": SearchResultPageInfo,
  "total_count": 987
}

CartPrices

Contains details about the final price of items in the cart, including discount and tax information.

Fields

Field NameDescription
applied_taxes - [CartTaxItem]
An array containing the names and amounts of taxes applied to each item in the cart.
discount - CartDiscount
(Deprecated: Use discounts instead.)
discounts - [Discount]
An array containing cart rule discounts, store credit and gift cards applied to the cart.
gift_options - GiftOptionsPrices
The list of prices for the selected gift options.
grand_total - Money
The total, including discounts, taxes, shipping, and other fees.
grand_total_excluding_tax - Money
The total of the cart, including discounts, shipping, and other fees without tax.
subtotal_excluding_tax - Money
The subtotal without any applied taxes.
subtotal_including_tax - Money
The subtotal including any applied taxes.
subtotal_with_discount_excluding_tax - Money
The subtotal with any discounts applied, but not taxes.

Example

Copied to your clipboard
{
  "applied_taxes": [CartTaxItem],
  "discount": CartDiscount,
  "discounts": [Discount],
  "gift_options": GiftOptionsPrices,
  "grand_total": Money,
  "grand_total_excluding_tax": Money,
  "subtotal_excluding_tax": Money,
  "subtotal_including_tax": Money,
  "subtotal_with_discount_excluding_tax": Money
}

CartRuleStorefront

Fields

Field NameDescription
uid - ID!
The unique ID for a `CartRule` object.

Example

Copied to your clipboard
{"uid": "4"}

CartTaxItem

Contains tax information about an item in the cart.

Fields

Field NameDescription
amount - Money!
The amount of tax applied to the item.
label - String!
The description of the tax.

Example

Copied to your clipboard
{
  "amount": Money,
  "label": "abc123"
}

CartUserInputError

Fields

Field NameDescription
code - CartUserInputErrorType!
A cart-specific error code.
message - String!
A localized error message.

Example

Copied to your clipboard
{
  "code": "PRODUCT_NOT_FOUND",
  "message": "abc123"
}

CartUserInputErrorType

Values

Enum ValueDescription
PRODUCT_NOT_FOUND
NOT_SALABLE
INSUFFICIENT_STOCK
COULD_NOT_FIND_CART_ITEM
REQUIRED_PARAMETER_MISSING
INVALID_PARAMETER_VALUE
UNDEFINED
PERMISSION_DENIED

Example

Copied to your clipboard
""PRODUCT_NOT_FOUND""

CatalogAttributeApplyToEnum

Values

Enum ValueDescription
SIMPLE
VIRTUAL
BUNDLE
DOWNLOADABLE
CONFIGURABLE
GROUPED
CATEGORY

Example

Copied to your clipboard
""SIMPLE""

CatalogAttributeMetadata

Swatch attribute metadata.

Fields

Field NameDescription
apply_to - [CatalogAttributeApplyToEnum]
To which catalog types an attribute can be applied.
code - ID!
The unique identifier for an attribute code. This value should be in lowercase letters without spaces.
default_value - String
Default attribute value.
entity_type - AttributeEntityTypeEnum!
The type of entity that defines the attribute.
frontend_class - String
The frontend class of the attribute.
frontend_input - AttributeFrontendInputEnum
The frontend input type of the attribute.
is_comparable - Boolean
Whether a product or category attribute can be compared against another or not.
is_filterable - Boolean
Whether a product or category attribute can be filtered or not.
is_filterable_in_search - Boolean
Whether a product or category attribute can be filtered in search or not.
is_html_allowed_on_front - Boolean
Whether a product or category attribute can use HTML on front or not.
is_required - Boolean!
Whether the attribute value is required.
is_searchable - Boolean
Whether a product or category attribute can be searched or not.
is_unique - Boolean!
Whether the attribute value must be unique.
is_used_for_price_rules - Boolean
Whether a product or category attribute can be used for price rules or not.
is_used_for_promo_rules - Boolean
Whether a product or category attribute is used for promo rules or not.
is_visible_in_advanced_search - Boolean
Whether a product or category attribute is visible in advanced search or not.
is_visible_on_front - Boolean
Whether a product or category attribute is visible on front or not.
is_wysiwyg_enabled - Boolean
Whether a product or category attribute has WYSIWYG enabled or not.
label - String
The label assigned to the attribute.
options - [CustomAttributeOptionInterface]!
Attribute options.
swatch_input_type - SwatchInputTypeEnum
Input type of the swatch attribute option.
update_product_preview_image - Boolean
Whether update product preview image or not.
use_product_image_for_swatch - Boolean
Whether use product image for swatch or not.
used_in_product_listing - Boolean
Whether a product or category attribute is used in product listing or not.

Example

Copied to your clipboard
{
  "apply_to": ["SIMPLE"],
  "code": "4",
  "default_value": "xyz789",
  "entity_type": "CATALOG_PRODUCT",
  "frontend_class": "xyz789",
  "frontend_input": "BOOLEAN",
  "is_comparable": false,
  "is_filterable": true,
  "is_filterable_in_search": false,
  "is_html_allowed_on_front": true,
  "is_required": false,
  "is_searchable": false,
  "is_unique": false,
  "is_used_for_price_rules": false,
  "is_used_for_promo_rules": false,
  "is_visible_in_advanced_search": true,
  "is_visible_on_front": true,
  "is_wysiwyg_enabled": false,
  "label": "xyz789",
  "options": [CustomAttributeOptionInterface],
  "swatch_input_type": "BOOLEAN",
  "update_product_preview_image": false,
  "use_product_image_for_swatch": true,
  "used_in_product_listing": true
}

CategoryFilterInput

Defines the filters to be used in the search. A filter contains at least one attribute, a comparison operator, and the value that is being searched for.

Input Fields

Input FieldDescription
category_uid - FilterEqualTypeInput
Filter by the unique category ID for a `CategoryInterface` object.
ids - FilterEqualTypeInput
Deprecated: use 'category_uid' to filter uniquely identifiers of categories.
name - FilterMatchTypeInput
Filter by the display name of the category.
parent_category_uid - FilterEqualTypeInput
Filter by the unique parent category ID for a `CategoryInterface` object.
parent_id - FilterEqualTypeInput
Filter by the unique parent category ID for a `CategoryInterface` object.
url_key - FilterEqualTypeInput
Filter by the part of the URL that identifies the category.
url_path - FilterEqualTypeInput
Filter by the URL path for the category.

Example

Copied to your clipboard
{
  "category_uid": FilterEqualTypeInput,
  "ids": FilterEqualTypeInput,
  "name": FilterMatchTypeInput,
  "parent_category_uid": FilterEqualTypeInput,
  "parent_id": FilterEqualTypeInput,
  "url_key": FilterEqualTypeInput,
  "url_path": FilterEqualTypeInput
}

CategoryInterface

Contains the full set of attributes that can be returned in a category search.

Fields

Field NameDescription
automatic_sorting - String
available_sort_by - [String]
breadcrumbs - [Breadcrumb]
An array of breadcrumb items.
canonical_url - String
The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Categories' is enabled.
children_count - String
cms_block - CmsBlock
Contains a category CMS block.
created_at - String
The timestamp indicating when the category was created. (Deprecated: The field should not be used on the storefront.)
custom_layout_update_file - String
default_sort_by - String
The attribute to use for sorting.
description - String
An optional description of the category.
display_mode - String
filter_price_range - Float
id - Int
An ID that uniquely identifies the category. (Deprecated: Use `uid` instead.)
image - String
include_in_menu - Int
is_anchor - Int
landing_page - Int
level - Int
The depth of the category within the tree.
meta_description - String
meta_keywords - String
meta_title - String
name - String
The display name of the category.
path - String
The full category path.
path_in_store - String
The category path within the store.
position - Int
The position of the category relative to other categories at the same level in tree.
product_count - Int
The number of products in the category that are marked as visible. By default, in complex products, parent products are visible, but their child products are not.
products - CategoryProducts
The list of products assigned to the category.
staged - Boolean!
Indicates whether the category is staged for a future campaign.
uid - ID!
The unique ID for a `CategoryInterface` object.
updated_at - String
The timestamp indicating when the category was updated. (Deprecated: The field should not be used on the storefront.)
url_key - String
The URL key assigned to the category.
url_path - String
The URL path assigned to the category.
url_suffix - String
The part of the category URL that is appended after the url key

Possible Types

CategoryInterface Types
CategoryTree

Example

Copied to your clipboard
{
  "automatic_sorting": "xyz789",
  "available_sort_by": ["abc123"],
  "breadcrumbs": [Breadcrumb],
  "canonical_url": "xyz789",
  "children_count": "abc123",
  "cms_block": CmsBlock,
  "created_at": "abc123",
  "custom_layout_update_file": "xyz789",
  "default_sort_by": "xyz789",
  "description": "xyz789",
  "display_mode": "abc123",
  "filter_price_range": 987.65,
  "id": 987,
  "image": "abc123",
  "include_in_menu": 987,
  "is_anchor": 987,
  "landing_page": 987,
  "level": 987,
  "meta_description": "abc123",
  "meta_keywords": "xyz789",
  "meta_title": "abc123",
  "name": "xyz789",
  "path": "xyz789",
  "path_in_store": "abc123",
  "position": 123,
  "product_count": 123,
  "products": CategoryProducts,
  "staged": false,
  "uid": "4",
  "updated_at": "xyz789",
  "url_key": "xyz789",
  "url_path": "abc123",
  "url_suffix": "abc123"
}

CategoryProducts

Contains details about the products assigned to a category.

Fields

Field NameDescription
items - [ProductInterface]
An array of products that are assigned to the category.
page_info - SearchResultPageInfo
Pagination metadata.
total_count - Int
The number of products in the category that are marked as visible. By default, in complex products, parent products are visible, but their child products are not.

Example

Copied to your clipboard
{
  "items": [ProductInterface],
  "page_info": SearchResultPageInfo,
  "total_count": 987
}

CategoryResult

Contains a collection of CategoryTree objects and pagination information.

Fields

Field NameDescription
items - [CategoryTree]
A list of categories that match the filter criteria.
page_info - SearchResultPageInfo
An object that includes the `page_info` and `currentPage` values specified in the query.
total_count - Int
The total number of categories that match the criteria.

Example

Copied to your clipboard
{
  "items": [CategoryTree],
  "page_info": SearchResultPageInfo,
  "total_count": 987
}

CategoryTree

Contains the hierarchy of categories.

Fields

Field NameDescription
automatic_sorting - String
available_sort_by - [String]
breadcrumbs - [Breadcrumb]
An array of breadcrumb items.
canonical_url - String
The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Categories' is enabled.
children - [CategoryTree]
A tree of child categories.
children_count - String
cms_block - CmsBlock
Contains a category CMS block.
created_at - String
The timestamp indicating when the category was created. (Deprecated: The field should not be used on the storefront.)
custom_layout_update_file - String
default_sort_by - String
The attribute to use for sorting.
description - String
An optional description of the category.
display_mode - String
filter_price_range - Float
id - Int
An ID that uniquely identifies the category. (Deprecated: Use `uid` instead.)
image - String
include_in_menu - Int
is_anchor - Int
landing_page - Int
level - Int
The depth of the category within the tree.
meta_description - String
meta_keywords - String
meta_title - String
name - String
The display name of the category.
path - String
The full category path.
path_in_store - String
The category path within the store.
position - Int
The position of the category relative to other categories at the same level in tree.
product_count - Int
The number of products in the category that are marked as visible. By default, in complex products, parent products are visible, but their child products are not.
products - CategoryProducts
The list of products assigned to the category.
redirect_code - Int!
Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.
relative_url - String
The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.
staged - Boolean!
Indicates whether the category is staged for a future campaign.
type - UrlRewriteEntityTypeEnum
One of PRODUCT, CATEGORY, or CMS_PAGE.
uid - ID!
The unique ID for a `CategoryInterface` object.
updated_at - String
The timestamp indicating when the category was updated. (Deprecated: The field should not be used on the storefront.)
url_key - String
The URL key assigned to the category.
url_path - String
The URL path assigned to the category.
url_suffix - String
The part of the category URL that is appended after the url key

Example

Copied to your clipboard
{
  "automatic_sorting": "xyz789",
  "available_sort_by": ["xyz789"],
  "breadcrumbs": [Breadcrumb],
  "canonical_url": "abc123",
  "children": [CategoryTree],
  "children_count": "xyz789",
  "cms_block": CmsBlock,
  "created_at": "abc123",
  "custom_layout_update_file": "xyz789",
  "default_sort_by": "xyz789",
  "description": "xyz789",
  "display_mode": "xyz789",
  "filter_price_range": 987.65,
  "id": 123,
  "image": "abc123",
  "include_in_menu": 123,
  "is_anchor": 987,
  "landing_page": 987,
  "level": 123,
  "meta_description": "abc123",
  "meta_keywords": "abc123",
  "meta_title": "abc123",
  "name": "abc123",
  "path": "xyz789",
  "path_in_store": "xyz789",
  "position": 987,
  "product_count": 123,
  "products": CategoryProducts,
  "redirect_code": 987,
  "relative_url": "abc123",
  "staged": false,
  "type": "CMS_PAGE",
  "uid": "4",
  "updated_at": "abc123",
  "url_key": "xyz789",
  "url_path": "xyz789",
  "url_suffix": "xyz789"
}

CheckoutAgreement

Defines details about an individual checkout agreement.

Fields

Field NameDescription
agreement_id - Int!
The ID for a checkout agreement.
checkbox_text - String!
The checkbox text for the checkout agreement.
content - String!
Required. The text of the agreement.
content_height - String
The height of the text box where the Terms and Conditions statement appears during checkout.
is_html - Boolean!
Indicates whether the `content` text is in HTML format.
mode - CheckoutAgreementMode!
Indicates whether agreements are accepted automatically or manually.
name - String!
The name given to the condition.

Example

Copied to your clipboard
{
  "agreement_id": 987,
  "checkbox_text": "xyz789",
  "content": "xyz789",
  "content_height": "abc123",
  "is_html": true,
  "mode": "AUTO",
  "name": "xyz789"
}

CheckoutAgreementMode

Indicates how agreements are accepted.

Values

Enum ValueDescription
AUTO
Conditions are automatically accepted upon checkout.
MANUAL
Shoppers must manually accept the conditions to place an order.

Example

Copied to your clipboard
""AUTO""

CheckoutUserInputError

An error encountered while adding an item to the cart.

Fields

Field NameDescription
code - CheckoutUserInputErrorCodes!
An error code that is specific to Checkout.
message - String!
A localized error message.
path - [String]!
The path to the input field that caused an error. See the GraphQL specification about path errors for details: http://spec.graphql.org/draft/#sec-Errors

Example

Copied to your clipboard
{
  "code": "REORDER_NOT_AVAILABLE",
  "message": "xyz789",
  "path": ["xyz789"]
}

CheckoutUserInputErrorCodes

Values

Enum ValueDescription
REORDER_NOT_AVAILABLE
PRODUCT_NOT_FOUND
NOT_SALABLE
INSUFFICIENT_STOCK
UNDEFINED

Example

Copied to your clipboard
""REORDER_NOT_AVAILABLE""

ClearCartError

Contains details about errors encountered when a customer clear cart.

Fields

Field NameDescription
message - String!
A localized error message
type - ClearCartErrorType!
A cart-specific error type.

Example

Copied to your clipboard
{"message": "abc123", "type": "NOT_FOUND"}

ClearCartErrorType

Values

Enum ValueDescription
NOT_FOUND
UNAUTHORISED
INACTIVE
UNDEFINED

Example

Copied to your clipboard
""NOT_FOUND""

ClearCartInput

Assigns a specific cart_id to the empty cart.

Input Fields

Input FieldDescription
uid - ID!
The unique ID of a `Cart` object.

Example

Copied to your clipboard
{"uid": 4}

ClearCartOutput

Output of the request to clear the customer cart.

Fields

Field NameDescription
cart - Cart
The cart after clear cart items.
errors - [ClearCartError]
An array of errors encountered while clearing the cart item

Example

Copied to your clipboard
{
  "cart": Cart,
  "errors": [ClearCartError]
}

ClearCustomerCartOutput

Output of the request to clear the customer cart.

Fields

Field NameDescription
cart - Cart
The cart after clearing items.
status - Boolean!
Indicates whether cart was cleared.

Example

Copied to your clipboard
{"cart": Cart, "status": false}

CloseNegotiableQuoteError

Types

Union Types
NegotiableQuoteInvalidStateError
NoSuchEntityUidError
InternalError

Example

Copied to your clipboard
NegotiableQuoteInvalidStateError

CloseNegotiableQuoteOperationFailure

Contains details about a failed close operation on a negotiable quote.

Fields

Field NameDescription
errors - [CloseNegotiableQuoteError]!
An array of errors encountered while attempting close the negotiable quote.
quote_uid - ID!
The unique ID of a `NegotiableQuote` object.

Example

Copied to your clipboard
{
  "errors": [NegotiableQuoteInvalidStateError],
  "quote_uid": "4"
}

CloseNegotiableQuoteOperationResult

Types

Union Types
NegotiableQuoteUidOperationSuccess
CloseNegotiableQuoteOperationFailure

Example

Copied to your clipboard
NegotiableQuoteUidOperationSuccess

CloseNegotiableQuotesInput

Defines the negotiable quotes to mark as closed.

Input Fields

Input FieldDescription
quote_uids - [ID]!
A list of unique IDs from `NegotiableQuote` objects.

Example

Copied to your clipboard
{"quote_uids": [4]}

CloseNegotiableQuotesOutput

Contains the closed negotiable quotes and other negotiable quotes the company user can view.

Fields

Field NameDescription
closed_quotes - [NegotiableQuote]
An array containing the negotiable quotes that were just closed. (Deprecated: Use `operation_results` instead.)
negotiable_quotes - NegotiableQuotesOutput
A list of negotiable quotes that can be viewed by the logged-in customer
operation_results - [CloseNegotiableQuoteOperationResult]!
An array of closed negotiable quote UIDs and details about any errors.
result_status - BatchMutationStatus!
The status of the request to close one or more negotiable quotes.

Example

Copied to your clipboard
{
  "closed_quotes": [NegotiableQuote],
  "negotiable_quotes": NegotiableQuotesOutput,
  "operation_results": [
    NegotiableQuoteUidOperationSuccess
  ],
  "result_status": "SUCCESS"
}

CmsBlock

Contains details about a specific CMS block.

Fields

Field NameDescription
content - String
The content of the CMS block in raw HTML.
identifier - String
The CMS block identifier.
title - String
The title assigned to the CMS block.

Example

Copied to your clipboard
{
  "content": "xyz789",
  "identifier": "xyz789",
  "title": "xyz789"
}

CmsBlocks

Contains an array CMS block items.

Fields

Field NameDescription
items - [CmsBlock]
An array of CMS blocks.

Example

Copied to your clipboard
{"items": [CmsBlock]}

CmsPage

Contains details about a CMS page.

Fields

Field NameDescription
content - String
The content of the CMS page in raw HTML.
content_heading - String
The heading that displays at the top of the CMS page.
identifier - String
The ID of a CMS page.
meta_description - String
A brief description of the page for search results listings.
meta_keywords - String
A brief description of the page for search results listings.
meta_title - String
A page title that is indexed by search engines and appears in search results listings.
page_layout - String
The design layout of the page, indicating the number of columns and navigation features used on the page.
redirect_code - Int!
Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.
relative_url - String
The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.
title - String
The name that appears in the breadcrumb trail navigation and in the browser title bar and tab.
type - UrlRewriteEntityTypeEnum
One of PRODUCT, CATEGORY, or CMS_PAGE.
url_key - String
The URL key of the CMS page, which is often based on the `content_heading`.

Example

Copied to your clipboard
{
  "content": "xyz789",
  "content_heading": "xyz789",
  "identifier": "abc123",
  "meta_description": "abc123",
  "meta_keywords": "abc123",
  "meta_title": "abc123",
  "page_layout": "xyz789",
  "redirect_code": 123,
  "relative_url": "abc123",
  "title": "xyz789",
  "type": "CMS_PAGE",
  "url_key": "abc123"
}

ColorSwatchData

Fields

Field NameDescription
value - String
The value can be represented as color (HEX code), image link, or text.

Example

Copied to your clipboard
{"value": "xyz789"}

CompaniesSortFieldEnum

The fields available for sorting the customer companies.

Values

Enum ValueDescription
NAME
The name of the company.

Example

Copied to your clipboard
""NAME""

CompaniesSortInput

Specifies which field to sort on, and whether to return the results in ascending or descending order.

Input Fields

Input FieldDescription
field - CompaniesSortFieldEnum!
The field for sorting the results.
order - SortEnum!
Indicates whether to return results in ascending or descending order.

Example

Copied to your clipboard
{"field": "NAME", "order": "ASC"}

Company

Contains the output schema for a company.

Fields

Field NameDescription
acl_resources - [CompanyAclResource]
The list of all resources defined within the company.
company_admin - Customer
An object containing information about the company administrator.
credit - CompanyCredit!
Company credit balances and limits.
credit_history - CompanyCreditHistory!
Details about the history of company credit operations.
email - String
The email address of the company contact.
id - ID!
The unique ID of a `Company` object.
legal_address - CompanyLegalAddress
The address where the company is registered to conduct business.
legal_name - String
The full legal name of the company.
name - String
The name of the company.
payment_methods - [String]
The list of payment methods available to a company.
reseller_id - String
The resale number that is assigned to the company for tax reporting purposes.
role - CompanyRole
A company role filtered by the unique ID of a `CompanyRole` object.
roles - CompanyRoles!
An object that contains a list of company roles.
sales_representative - CompanySalesRepresentative
An object containing information about the company sales representative.
structure - CompanyStructure
The company structure of teams and customers in depth-first order.
team - CompanyTeam
The company team data filtered by the unique ID for a `CompanyTeam` object.
user - Customer
A company user filtered by the unique ID of a `Customer` object.
users - CompanyUsers
An object that contains a list of company users based on activity status.
vat_tax_id - String
The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes.

Example

Copied to your clipboard
{
  "acl_resources": [CompanyAclResource],
  "company_admin": Customer,
  "credit": CompanyCredit,
  "credit_history": CompanyCreditHistory,
  "email": "abc123",
  "id": "4",
  "legal_address": CompanyLegalAddress,
  "legal_name": "xyz789",
  "name": "xyz789",
  "payment_methods": ["abc123"],
  "reseller_id": "abc123",
  "role": CompanyRole,
  "roles": CompanyRoles,
  "sales_representative": CompanySalesRepresentative,
  "structure": CompanyStructure,
  "team": CompanyTeam,
  "user": Customer,
  "users": CompanyUsers,
  "vat_tax_id": "xyz789"
}

CompanyAclResource

Contains details about the access control list settings of a resource.

Fields

Field NameDescription
children - [CompanyAclResource]
An array of sub-resources.
id - ID!
The unique ID for a `CompanyAclResource` object.
sort_order - Int
The sort order of an ACL resource.
text - String
The label assigned to the ACL resource.

Example

Copied to your clipboard
{
  "children": [CompanyAclResource],
  "id": 4,
  "sort_order": 123,
  "text": "xyz789"
}

CompanyAdminInput

Defines the input schema for creating a company administrator.

Input Fields

Input FieldDescription
custom_attributes - [AttributeValueInput]
The company administrator's custom attributes.
email - String!
The email address of the company administrator.
firstname - String!
The company administrator's first name.
gender - Int
The company administrator's gender (Male - 1, Female - 2, Not Specified - 3).
job_title - String
The job title of the company administrator.
lastname - String!
The company administrator's last name.
telephone - String
The phone number of the company administrator.

Example

Copied to your clipboard
{
  "custom_attributes": [AttributeValueInput],
  "email": "xyz789",
  "firstname": "abc123",
  "gender": 123,
  "job_title": "xyz789",
  "lastname": "abc123",
  "telephone": "abc123"
}

CompanyBasicInfo

The minimal required information to identify and display the company.

Fields

Field NameDescription
id - ID!
The unique ID of a `Company` object.
legal_name - String
The full legal name of the company.
name - String
The name of the company.
status - CompanyStatusEnum
The current status of the company.

Example

Copied to your clipboard
{
  "id": 4,
  "legal_name": "abc123",
  "name": "abc123",
  "status": "PENDING"
}

CompanyCreateInput

Defines the input schema for creating a new company.

Input Fields

Input FieldDescription
company_admin - CompanyAdminInput!
Defines the company administrator.
company_email - String!
The email address of the company contact.
company_name - String!
The name of the company to create.
legal_address - CompanyLegalAddressCreateInput!
Defines legal address data of the company.
legal_name - String
The full legal name of the company.
reseller_id - String
The resale number that is assigned to the company for tax reporting purposes.
vat_tax_id - String
The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes.

Example

Copied to your clipboard
{
  "company_admin": CompanyAdminInput,
  "company_email": "abc123",
  "company_name": "xyz789",
  "legal_address": CompanyLegalAddressCreateInput,
  "legal_name": "abc123",
  "reseller_id": "xyz789",
  "vat_tax_id": "abc123"
}

CompanyCredit

Contains company credit balances and limits.

Fields

Field NameDescription
available_credit - Money!
The sum of the credit limit and the outstanding balance. If the company has exceeded the credit limit, the amount is as a negative value.
credit_limit - Money!
The amount of credit extended to the company.
outstanding_balance - Money!
The amount reimbursed, less the total due from all orders placed using the Payment on Account payment method. The amount can be a positive or negative value.

Example

Copied to your clipboard
{
  "available_credit": Money,
  "credit_limit": Money,
  "outstanding_balance": Money
}

CompanyCreditHistory

Contains details about prior company credit operations.

Fields

Field NameDescription
items - [CompanyCreditOperation]!
An array of company credit operations.
page_info - SearchResultPageInfo!
Metadata for pagination rendering.
total_count - Int
The number of the company credit operations matching the specified filter.

Example

Copied to your clipboard
{
  "items": [CompanyCreditOperation],
  "page_info": SearchResultPageInfo,
  "total_count": 123
}

CompanyCreditHistoryFilterInput

Defines a filter for narrowing the results of a credit history search.

Input Fields

Input FieldDescription
custom_reference_number - String
The purchase order number associated with the company credit operation.
operation_type - CompanyCreditOperationType
The type of the company credit operation.
updated_by - String
The name of the person submitting the company credit operation.

Example

Copied to your clipboard
{
  "custom_reference_number": "abc123",
  "operation_type": "ALLOCATION",
  "updated_by": "xyz789"
}

CompanyCreditOperation

Contains details about a single company credit operation.

Fields

Field NameDescription
amount - Money
The amount of the company credit operation.
balance - CompanyCredit!
The credit balance as a result of the operation.
custom_reference_number - String
The purchase order number associated with the company credit operation.
date - String!
The date the operation occurred.
type - CompanyCreditOperationType!
The type of the company credit operation.
updated_by - CompanyCreditOperationUser!
The company user that submitted the company credit operation.

Example

Copied to your clipboard
{
  "amount": Money,
  "balance": CompanyCredit,
  "custom_reference_number": "xyz789",
  "date": "xyz789",
  "type": "ALLOCATION",
  "updated_by": CompanyCreditOperationUser
}

CompanyCreditOperationType

Values

Enum ValueDescription
ALLOCATION
UPDATE
PURCHASE
REIMBURSEMENT
REFUND
REVERT

Example

Copied to your clipboard
""ALLOCATION""

CompanyCreditOperationUser

Defines the administrator or company user that submitted a company credit operation.

Fields

Field NameDescription
name - String!
The name of the company user submitting the company credit operation.
type - CompanyCreditOperationUserType!
The type of the company user submitting the company credit operation.

Example

Copied to your clipboard
{"name": "abc123", "type": "CUSTOMER"}

CompanyCreditOperationUserType

Values

Enum ValueDescription
CUSTOMER
ADMIN

Example

Copied to your clipboard
""CUSTOMER""

CompanyInvitationInput

Defines the input schema for accepting the company invitation.

Input Fields

Input FieldDescription
code - String!
The invitation code.
role_id - ID
The company role id.
user - CompanyInvitationUserInput!
Company user attributes in the invitation.

Example

Copied to your clipboard
{
  "code": "abc123",
  "role_id": 4,
  "user": CompanyInvitationUserInput
}

CompanyInvitationOutput

The result of accepting the company invitation.

Fields

Field NameDescription
success - Boolean
Indicates whether the customer was added to the company successfully.

Example

Copied to your clipboard
{"success": true}

CompanyInvitationUserInput

Company user attributes in the invitation.

Input Fields

Input FieldDescription
company_id - ID!
The company unique identifier.
customer_id - ID!
The customer unique identifier.
job_title - String
The job title of a company user.
status - CompanyUserStatusEnum
Indicates whether the company user is ACTIVE or INACTIVE.
telephone - String
The phone number of the company user.

Example

Copied to your clipboard
{
  "company_id": "4",
  "customer_id": 4,
  "job_title": "abc123",
  "status": "ACTIVE",
  "telephone": "abc123"
}

CompanyLegalAddress

Contains details about the address where the company is registered to conduct business.

Fields

Field NameDescription
city - String
The city where the company is registered to conduct business.
country_code - CountryCodeEnum
The country code of the company's legal address.
postcode - String
The company's postal code.
region - CustomerAddressRegion
An object containing region data for the company.
street - [String]
An array of strings that define the company's street address.
telephone - String
The company's phone number.

Example

Copied to your clipboard
{
  "city": "abc123",
  "country_code": "AF",
  "postcode": "abc123",
  "region": CustomerAddressRegion,
  "street": ["abc123"],
  "telephone": "abc123"
}

CompanyLegalAddressCreateInput

Defines the input schema for defining a company's legal address.

Input Fields

Input FieldDescription
city - String!
The city where the company is registered to conduct business.
country_id - CountryCodeEnum!
The company's country ID. Use the `countries` query to get this value.
postcode - String!
The postal code of the company.
region - CustomerAddressRegionInput!
An object containing the region name and/or region ID where the company is registered to conduct business.
street - [String]!
An array of strings that define the street address where the company is registered to conduct business.
telephone - String!
The primary phone number of the company.

Example

Copied to your clipboard
{
  "city": "abc123",
  "country_id": "AF",
  "postcode": "xyz789",
  "region": CustomerAddressRegionInput,
  "street": ["abc123"],
  "telephone": "abc123"
}

CompanyLegalAddressUpdateInput

Defines the input schema for updating a company's legal address.

Input Fields

Input FieldDescription
city - String
The city where the company is registered to conduct business.
country_id - CountryCodeEnum
The unique ID for a `Country` object.
postcode - String
The postal code of the company.
region - CustomerAddressRegionInput
An object containing the region name and/or region ID where the company is registered to conduct business.
street - [String]
An array of strings that define the street address where the company is registered to conduct business.
telephone - String
The primary phone number of the company.

Example

Copied to your clipboard
{
  "city": "xyz789",
  "country_id": "AF",
  "postcode": "abc123",
  "region": CustomerAddressRegionInput,
  "street": ["abc123"],
  "telephone": "xyz789"
}

CompanyRole

Contails details about a single role.

Fields

Field NameDescription
id - ID!
The unique ID for a `CompanyRole` object.
name - String
The name assigned to the role.
permissions - [CompanyAclResource]
A list of permission resources defined for a role.
users_count - Int
The total number of users assigned the specified role.

Example

Copied to your clipboard
{
  "id": 4,
  "name": "xyz789",
  "permissions": [CompanyAclResource],
  "users_count": 987
}

CompanyRoleCreateInput

Defines the input schema for creating a company role.

Input Fields

Input FieldDescription
name - String!
The name of the role to create.
permissions - [String]!
A list of resources the role can access.

Example

Copied to your clipboard
{
  "name": "xyz789",
  "permissions": ["xyz789"]
}

CompanyRoleUpdateInput

Defines the input schema for updating a company role.

Input Fields

Input FieldDescription
id - ID!
The unique ID for a `CompanyRole` object.
name - String
The name of the role to update.
permissions - [String]
A list of resources the role can access.

Example

Copied to your clipboard
{
  "id": 4,
  "name": "abc123",
  "permissions": ["abc123"]
}

CompanyRoles

Contains an array of roles.

Fields

Field NameDescription
items - [CompanyRole]!
A list of company roles that match the specified filter criteria.
page_info - SearchResultPageInfo
Pagination metadata.
total_count - Int!
The total number of objects matching the specified filter.

Example

Copied to your clipboard
{
  "items": [CompanyRole],
  "page_info": SearchResultPageInfo,
  "total_count": 987
}

CompanySalesRepresentative

Contains details about a company sales representative.

Fields

Field NameDescription
email - String
The email address of the company sales representative.
firstname - String
The company sales representative's first name.
lastname - String
The company sales representative's last name.

Example

Copied to your clipboard
{
  "email": "xyz789",
  "firstname": "xyz789",
  "lastname": "abc123"
}

CompanyStatusEnum

Defines the list of company status values.

Values

Enum ValueDescription
PENDING
Company is pending approval.
APPROVED
Company is approved.
REJECTED
Company is rejected.
BLOCKED
Company is blocked.

Example

Copied to your clipboard
""PENDING""

CompanyStructure

Contains an array of the individual nodes that comprise the company structure.

Fields

Field NameDescription
items - [CompanyStructureItem]
An array of elements in a company structure.

Example

Copied to your clipboard
{"items": [CompanyStructureItem]}

CompanyStructureEntity

Types

Union Types
CompanyTeam
Customer

Example

Copied to your clipboard
CompanyTeam

CompanyStructureItem

Defines an individual node in the company structure.

Fields

Field NameDescription
entity - CompanyStructureEntity
A union of `CompanyTeam` and `Customer` objects.
id - ID!
The unique ID for a `CompanyStructureItem` object.
parent_id - ID
The ID of the parent item in the company hierarchy.

Example

Copied to your clipboard
{"entity": CompanyTeam, "id": 4, "parent_id": 4}

CompanyStructureUpdateInput

Defines the input schema for updating the company structure.

Input Fields

Input FieldDescription
parent_tree_id - ID!
The ID of a company that will be the new parent.
tree_id - ID!
The ID of the company team that is being moved to another parent.

Example

Copied to your clipboard
{"parent_tree_id": 4, "tree_id": 4}

CompanyTeam

Describes a company team.

Fields

Field NameDescription
description - String
An optional description of the team.
id - ID
The unique ID for a `CompanyTeam` object.
name - String
The display name of the team.
structure_id - ID!
ID of the company structure

Example

Copied to your clipboard
{
  "description": "abc123",
  "id": 4,
  "name": "xyz789",
  "structure_id": 4
}

CompanyTeamCreateInput

Defines the input schema for creating a company team.

Input Fields

Input FieldDescription
description - String
An optional description of the team.
name - String!
The display name of the team.
target_id - ID
The ID of a node within a company's structure. This ID will be the parent of the created team.

Example

Copied to your clipboard
{
  "description": "abc123",
  "name": "xyz789",
  "target_id": "4"
}

CompanyTeamUpdateInput

Defines the input schema for updating a company team.

Input Fields

Input FieldDescription
description - String
An optional description of the team.
id - ID!
The unique ID of the `CompanyTeam` object to update.
name - String
The display name of the team.

Example

Copied to your clipboard
{
  "description": "xyz789",
  "id": 4,
  "name": "abc123"
}

CompanyUpdateInput

Defines the input schema for updating a company.

Input Fields

Input FieldDescription
company_email - String
The email address of the company contact.
company_name - String
The name of the company to update.
legal_address - CompanyLegalAddressUpdateInput
The legal address data of the company.
legal_name - String
The full legal name of the company.
reseller_id - String
The resale number that is assigned to the company for tax reporting purposes.
vat_tax_id - String
The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes.

Example

Copied to your clipboard
{
  "company_email": "xyz789",
  "company_name": "xyz789",
  "legal_address": CompanyLegalAddressUpdateInput,
  "legal_name": "abc123",
  "reseller_id": "xyz789",
  "vat_tax_id": "xyz789"
}

CompanyUserCreateInput

Defines the input schema for creating a company user.

Input Fields

Input FieldDescription
email - String!
The company user's email address
firstname - String!
The company user's first name.
job_title - String!
The company user's job title or function.
lastname - String!
The company user's last name.
role_id - ID!
The unique ID for a `CompanyRole` object.
status - CompanyUserStatusEnum!
Indicates whether the company user is ACTIVE or INACTIVE.
target_id - ID
The ID of a node within a company's structure. This ID will be the parent of the created company user.
telephone - String!
The company user's phone number.

Example

Copied to your clipboard
{
  "email": "abc123",
  "firstname": "abc123",
  "job_title": "abc123",
  "lastname": "abc123",
  "role_id": "4",
  "status": "ACTIVE",
  "target_id": 4,
  "telephone": "xyz789"
}

CompanyUserStatusEnum

Defines the list of company user status values.

Values

Enum ValueDescription
ACTIVE
Only active users.
INACTIVE
Only inactive users.

Example

Copied to your clipboard
""ACTIVE""

CompanyUserUpdateInput

Defines the input schema for updating a company user.

Input Fields

Input FieldDescription
email - String
The company user's email address.
firstname - String
The company user's first name.
id - ID!
The unique ID of a `Customer` object.
job_title - String
The company user's job title or function.
lastname - String
The company user's last name.
role_id - ID
The unique ID for a `CompanyRole` object.
status - CompanyUserStatusEnum
Indicates whether the company user is ACTIVE or INACTIVE.
telephone - String
The company user's phone number.

Example

Copied to your clipboard
{
  "email": "abc123",
  "firstname": "xyz789",
  "id": "4",
  "job_title": "abc123",
  "lastname": "abc123",
  "role_id": "4",
  "status": "ACTIVE",
  "telephone": "xyz789"
}

CompanyUsers

Contains details about company users.

Fields

Field NameDescription
items - [Customer]!
An array of `CompanyUser` objects that match the specified filter criteria.
page_info - SearchResultPageInfo
Pagination metadata.
total_count - Int!
The number of objects returned.

Example

Copied to your clipboard
{
  "items": [Customer],
  "page_info": SearchResultPageInfo,
  "total_count": 987
}

CompanyUsersFilterInput

Defines the filter for returning a list of company users.

Input Fields

Input FieldDescription
status - CompanyUserStatusEnum
The activity status to filter on.

Example

Copied to your clipboard
{"status": "ACTIVE"}

ComparableAttribute

Contains an attribute code that is used for product comparisons.

Fields

Field NameDescription
code - String!
An attribute code that is enabled for product comparisons.
label - String!
The label of the attribute code.

Example

Copied to your clipboard
{
  "code": "xyz789",
  "label": "abc123"
}

ComparableItem

Defines an object used to iterate through items for product comparisons.

Fields

Field NameDescription
attributes - [ProductAttribute]!
An array of product attributes that can be used to compare products.
product - ProductInterface!
Details about a product in a compare list.
uid - ID!
The unique ID of an item in a compare list.

Example

Copied to your clipboard
{
  "attributes": [ProductAttribute],
  "product": ProductInterface,
  "uid": "4"
}

CompareList

Contains iterable information such as the array of items, the count, and attributes that represent the compare list.

Fields

Field NameDescription
attributes - [ComparableAttribute]
An array of attributes that can be used for comparing products.
item_count - Int!
The number of items in the compare list.
items - [ComparableItem]
An array of products to compare.
uid - ID!
The unique ID assigned to the compare list.

Example

Copied to your clipboard
{
  "attributes": [ComparableAttribute],
  "item_count": 123,
  "items": [ComparableItem],
  "uid": "4"
}

CompleteOrderInput

Update the quote and complete the order

Input Fields

Input FieldDescription
cartId - String!
The customer cart ID
id - String!
PayPal order ID

Example

Copied to your clipboard
{
  "cartId": "abc123",
  "id": "abc123"
}

ComplexTextValue

Fields

Field NameDescription
html - String!
Text that can contain HTML tags.

Example

Copied to your clipboard
{"html": "abc123"}

ConfigurableAttributeOption

Contains details about a configurable product attribute option.

Fields

Field NameDescription
code - String
The ID assigned to the attribute.
label - String
A string that describes the configurable attribute option.
uid - ID!
The unique ID for a `ConfigurableAttributeOption` object.
value_index - Int
A unique index number assigned to the configurable product option.

Example

Copied to your clipboard
{
  "code": "xyz789",
  "label": "abc123",
  "uid": "4",
  "value_index": 987
}

ConfigurableCartItem

An implementation for configurable product cart items.

Fields

Field NameDescription
available_gift_wrapping - [GiftWrapping]!
The list of available gift wrapping options for the cart item.
configurable_options - [SelectedConfigurableOption]!
An array containing the configuranle options the shopper selected.
configured_variant - ProductInterface!
Product details of the cart item.
customizable_options - [SelectedCustomizableOption]!
An array containing the customizable options the shopper selected.
discount - [Discount]
Contains discount for quote line item.
errors - [CartItemError]
An array of errors encountered while loading the cart item
gift_message - GiftMessage
The entered gift message for the cart item
gift_wrapping - GiftWrapping
The selected gift wrapping for the cart item.
id - String!
(Deprecated: Use `uid` instead.)
is_available - Boolean!
True if requested quantity is less than available stock, false otherwise.
max_qty - Float
Line item max qty in quote template
min_qty - Float
Line item min qty in quote template
not_available_message - String
Message to display when the product is not available with this selected option.
note_from_buyer - [ItemNote]
The buyer's quote line item note.
note_from_seller - [ItemNote]
The seller's quote line item note.
prices - CartItemPrices
Contains details about the price of the item, including taxes and discounts.
product - ProductInterface!
Details about an item in the cart.
quantity - Float!
The quantity of this item in the cart.
uid - ID!
The unique ID for a `CartItemInterface` object.

Example

Copied to your clipboard
{
  "available_gift_wrapping": [GiftWrapping],
  "configurable_options": [SelectedConfigurableOption],
  "configured_variant": ProductInterface,
  "customizable_options": [SelectedCustomizableOption],
  "discount": [Discount],
  "errors": [CartItemError],
  "gift_message": GiftMessage,
  "gift_wrapping": GiftWrapping,
  "id": "abc123",
  "is_available": false,
  "max_qty": 987.65,
  "min_qty": 987.65,
  "not_available_message": "xyz789",
  "note_from_buyer": [ItemNote],
  "note_from_seller": [ItemNote],
  "prices": CartItemPrices,
  "product": ProductInterface,
  "quantity": 123.45,
  "uid": "4"
}

ConfigurableOptionAvailableForSelection

Describes configurable options that have been selected and can be selected as a result of the previous selections.

Fields

Field NameDescription
attribute_code - String!
An attribute code that uniquely identifies a configurable option.
option_value_uids - [ID]!
An array of selectable option value IDs.

Example

Copied to your clipboard
{
  "attribute_code": "xyz789",
  "option_value_uids": ["4"]
}

ConfigurableOrderItem

Fields

Field NameDescription
discounts - [Discount]
The final discount information for the product.
eligible_for_return - Boolean
Indicates whether the order item is eligible to be in a return request.
entered_options - [OrderItemOption]
The entered option for the base product, such as a logo or image.
gift_message - GiftMessage
The selected gift message for the order item
gift_wrapping - GiftWrapping
The selected gift wrapping for the order item.
id - ID!
The unique ID for an `OrderItemInterface` object.
parent_sku - String
The SKU of parent product.
prices - OrderItemPrices
Contains details about the price of the item, including taxes and discounts.
product - ProductInterface
The ProductInterface object, which contains details about the base product
product_name - String
The name of the base product.
product_sale_price - Money!
The sale price of the base product, including selected options.
product_sku - String!
The SKU of the base product.
product_type - String
The type of product, such as simple, configurable, etc.
product_url_key - String
URL key of the base product.
quantity_canceled - Float
The number of canceled items.
quantity_invoiced - Float
The number of invoiced items.
quantity_ordered - Float
The number of units ordered for this item.
quantity_refunded - Float
The number of refunded items.
quantity_return_requested - Float
The requested return quantity of the item.
quantity_returned - Float
The number of returned items.
quantity_shipped - Float
The number of shipped items.
selected_options - [OrderItemOption]
The selected options for the base product, such as color or size.
status - String
The status of the order item.

Example

Copied to your clipboard
{
  "discounts": [Discount],
  "eligible_for_return": true,
  "entered_options": [OrderItemOption],
  "gift_message": GiftMessage,
  "gift_wrapping": GiftWrapping,
  "id": "4",
  "parent_sku": "xyz789",
  "prices": OrderItemPrices,
  "product": ProductInterface,
  "product_name": "abc123",
  "product_sale_price": Money,
  "product_sku": "xyz789",
  "product_type": "xyz789",
  "product_url_key": "abc123",
  "quantity_canceled": 123.45,
  "quantity_invoiced": 123.45,
  "quantity_ordered": 987.65,
  "quantity_refunded": 987.65,
  "quantity_return_requested": 123.45,
  "quantity_returned": 987.65,
  "quantity_shipped": 987.65,
  "selected_options": [OrderItemOption],
  "status": "xyz789"
}

ConfigurableProduct

Defines basic features of a configurable product and its simple product variants.

Fields

Field NameDescription
attribute_set_id - Int
The attribute set assigned to the product. (Deprecated: The field should not be used on the storefront.)
canonical_url - String
The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.
categories - [CategoryInterface]
The categories assigned to a product.
color - Int
(Deprecated: Use the `custom_attributes` field instead.)
configurable_options - [ConfigurableProductOptions]
An array of options for the configurable product.
configurable_product_options_selection - ConfigurableProductOptionsSelection
An array of media gallery items and other details about selected configurable product options as well as details about remaining selectable options.
country_of_manufacture - String
The product's country of origin.
created_at - String
Timestamp indicating when the product was created. (Deprecated: The field should not be used on the storefront.)
crosssell_products - [ProductInterface]
An array of cross-sell products.
custom_attributesV2 - ProductCustomAttributes
Product custom attributes.
description - ComplexTextValue
Detailed information about the product. The value can include simple HTML tags.
gift_message_available - Boolean!
Returns a value indicating gift message availability for the product.
gift_wrapping_available - Boolean!
Returns a value indicating gift wrapping availability for the product.
gift_wrapping_price - Money
Returns value and currency indicating gift wrapping price for the product.
id - Int
The ID number assigned to the product. (Deprecated: Use the `uid` field instead.)
image - ProductImage
The relative path to the main image on the product page.
is_returnable - String
Indicates whether the product can be returned.
manufacturer - Int
A number representing the product's manufacturer. (Deprecated: Use the `custom_attributes` field instead.)
max_sale_qty - Float
Maximum Qty Allowed in Shopping Cart
media_gallery - [MediaGalleryInterface]
An array of media gallery objects.
media_gallery_entries - [MediaGalleryEntry]
An array of MediaGalleryEntry objects. (Deprecated: Use `media_gallery` instead.)
meta_description - String
A brief overview of the product for search results listings, maximum 255 characters.
meta_keyword - String
A comma-separated list of keywords that are visible only to search engines.
meta_title - String
A string that is displayed in the title bar and tab of the browser and in search results lists.
min_sale_qty - Float
Minimum Qty Allowed in Shopping Cart
name - String
The product name. Customers use this name to identify the product.
new_from_date - String
The beginning date for new product listings, and determines if the product is featured as a new product.
new_to_date - String
The end date for new product listings.
only_x_left_in_stock - Float
Product stock only x left count
options - [CustomizableOptionInterface]
An array of options for a customizable product.
options_container - String
If the product has multiple options, determines where they appear on the product page.
price - ProductPrices
Indicates the price of an item. (Deprecated: Use `price_range` for product price information.)
price_range - PriceRange!
The range of prices for the product
price_tiers - [TierPrice]
An array of `TierPrice` objects.
product_links - [ProductLinksInterface]
An array of `ProductLinks` objects.
quantity - Float
Amount of available stock
rating_summary - Float!
The average of all the ratings given to the product.
redirect_code - Int!
Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.
related_products - [ProductInterface]
An array of related products.
relative_url - String
The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.
review_count - Int!
The total count of all the reviews given to the product.
reviews - ProductReviews!
The list of products reviews.
short_description - ComplexTextValue
A short description of the product. Its use depends on the theme.
sku - String
A number or code assigned to a product to identify the product, options, price, and manufacturer.
small_image - ProductImage
The relative path to the small image, which is used on catalog pages.
special_from_date - String
The beginning date that a product has a special price. (Deprecated: The field should not be used on the storefront.)
special_price - Float
The discounted price of the product.
special_to_date - String
The end date for a product with a special price.
staged - Boolean!
Indicates whether the product is staged for a future campaign.
stock_status - ProductStockStatus
Stock status of the product
swatch_image - String
The file name of a swatch image.
thumbnail - ProductImage
The relative path to the product's thumbnail image.
tier_price - Float
The price when tier pricing is in effect and the items purchased threshold has been reached. (Deprecated: Use `price_tiers` for product tier price information.)
tier_prices - [ProductTierPrices]
An array of ProductTierPrices objects. (Deprecated: Use `price_tiers` for product tier price information.)
type - UrlRewriteEntityTypeEnum
One of PRODUCT, CATEGORY, or CMS_PAGE.
type_id - String
One of simple, virtual, bundle, downloadable, grouped, or configurable. (Deprecated: Use `__typename` instead.)
uid - ID!
The unique ID for a `ProductInterface` object.
updated_at - String
Timestamp indicating when the product was updated. (Deprecated: The field should not be used on the storefront.)
upsell_products - [ProductInterface]
An array of up-sell products.
url_key - String
The part of the URL that identifies the product
url_path - String
(Deprecated: Use product's `canonical_url` or url rewrites instead)
url_rewrites - [UrlRewrite]
URL rewrites list
url_suffix - String
The part of the product URL that is appended after the url key
variants - [ConfigurableVariant]
An array of simple product variants.
websites - [Website]
An array of websites in which the product is available. (Deprecated: The field should not be used on the storefront.)
weight - Float
The weight of the item, in units defined by the store.

Example

Copied to your clipboard
{
  "attribute_set_id": 123,
  "canonical_url": "abc123",
  "categories": [CategoryInterface],
  "color": 987,
  "configurable_options": [ConfigurableProductOptions],
  "configurable_product_options_selection": ConfigurableProductOptionsSelection,
  "country_of_manufacture": "xyz789",
  "created_at": "abc123",
  "crosssell_products": [ProductInterface],
  "custom_attributesV2": ProductCustomAttributes,
  "description": ComplexTextValue,
  "gift_message_available": false,
  "gift_wrapping_available": true,
  "gift_wrapping_price": Money,
  "id": 987,
  "image": ProductImage,
  "is_returnable": "abc123",
  "manufacturer": 123,
  "max_sale_qty": 123.45,
  "media_gallery": [MediaGalleryInterface],
  "media_gallery_entries": [MediaGalleryEntry],
  "meta_description": "xyz789",
  "meta_keyword": "xyz789",
  "meta_title": "abc123",
  "min_sale_qty": 987.65,
  "name": "xyz789",
  "new_from_date": "xyz789",
  "new_to_date": "xyz789",
  "only_x_left_in_stock": 123.45,
  "options": [CustomizableOptionInterface],
  "options_container": "abc123",
  "price": ProductPrices,
  "price_range": PriceRange,
  "price_tiers": [TierPrice],
  "product_links": [ProductLinksInterface],
  "quantity": 987.65,
  "rating_summary": 987.65,
  "redirect_code": 123,
  "related_products": [ProductInterface],
  "relative_url": "xyz789",
  "review_count": 123,
  "reviews": ProductReviews,
  "short_description": ComplexTextValue,
  "sku": "xyz789",
  "small_image": ProductImage,
  "special_from_date": "abc123",
  "special_price": 123.45,
  "special_to_date": "xyz789",
  "staged": false,
  "stock_status": "IN_STOCK",
  "swatch_image": "abc123",
  "thumbnail": ProductImage,
  "tier_price": 123.45,
  "tier_prices": [ProductTierPrices],
  "type": "CMS_PAGE",
  "type_id": "abc123",
  "uid": 4,
  "updated_at": "abc123",
  "upsell_products": [ProductInterface],
  "url_key": "xyz789",
  "url_path": "xyz789",
  "url_rewrites": [UrlRewrite],
  "url_suffix": "xyz789",
  "variants": [ConfigurableVariant],
  "websites": [Website],
  "weight": 123.45
}

ConfigurableProductCartItemInput

Input Fields

Input FieldDescription
customizable_options - [CustomizableOptionInput]
The ID and value of the option.
data - CartItemInput!
The quantity and SKU of the configurable product.
parent_sku - String
The SKU of the parent configurable product.
variant_sku - String

Example

Copied to your clipboard
{
  "customizable_options": [CustomizableOptionInput],
  "data": CartItemInput,
  "parent_sku": "xyz789",
  "variant_sku": "abc123"
}

ConfigurableProductOption

Contains details about configurable product options.

Fields

Field NameDescription
attribute_code - String!
An attribute code that uniquely identifies a configurable option.
label - String!
The display name of the option.
uid - ID!
The unique ID of the configurable option.
values - [ConfigurableProductOptionValue]
An array of values that are applicable for this option.

Example

Copied to your clipboard
{
  "attribute_code": "xyz789",
  "label": "xyz789",
  "uid": 4,
  "values": [ConfigurableProductOptionValue]
}

ConfigurableProductOptionValue

Defines a value for a configurable product option.

Fields

Field NameDescription
is_available - Boolean!
Indicates whether the product is available with this selected option.
is_use_default - Boolean!
Indicates whether the value is the default.
label - String!
The display name of the value.
swatch - SwatchDataInterface
The URL assigned to the thumbnail of the swatch image.
uid - ID!
The unique ID of the value.

Example

Copied to your clipboard
{
  "is_available": false,
  "is_use_default": true,
  "label": "xyz789",
  "swatch": SwatchDataInterface,
  "uid": "4"
}

ConfigurableProductOptions

Defines configurable attributes for the specified product.

Fields

Field NameDescription
attribute_code - String
A string that identifies the attribute.
attribute_id - String
The ID assigned to the attribute. (Deprecated: Use `attribute_uid` instead.)
attribute_id_v2 - Int
The ID assigned to the attribute. (Deprecated: Use `attribute_uid` instead.)
attribute_uid - ID!
The unique ID for an `Attribute` object.
id - Int
The configurable option ID number assigned by the system. (Deprecated: Use `uid` instead.)
label - String
A displayed string that describes the configurable product option.
position - Int
A number that indicates the order in which the attribute is displayed.
product_id - Int
This is the same as a product's `id` field. (Deprecated: `product_id` is not needed and can be obtained from its parent.)
uid - ID!
The unique ID for a `ConfigurableProductOptions` object.
use_default - Boolean
Indicates whether the option is the default.
values - [ConfigurableProductOptionsValues]
An array that defines the `value_index` codes assigned to the configurable product.

Example

Copied to your clipboard
{
  "attribute_code": "xyz789",
  "attribute_id": "abc123",
  "attribute_id_v2": 987,
  "attribute_uid": 4,
  "id": 987,
  "label": "xyz789",
  "position": 987,
  "product_id": 123,
  "uid": 4,
  "use_default": false,
  "values": [ConfigurableProductOptionsValues]
}

ConfigurableProductOptionsSelection

Contains metadata corresponding to the selected configurable options.

Fields

Field NameDescription
configurable_options - [ConfigurableProductOption]
An array of all possible configurable options.
media_gallery - [MediaGalleryInterface]
Product images and videos corresponding to the specified configurable options selection.
options_available_for_selection - [ConfigurableOptionAvailableForSelection]
The configurable options available for further selection based on the current selection.
variant - SimpleProduct
A variant represented by the specified configurable options selection. The value is expected to be null until selections are made for each configurable option.

Example

Copied to your clipboard
{
  "configurable_options": [ConfigurableProductOption],
  "media_gallery": [MediaGalleryInterface],
  "options_available_for_selection": [
    ConfigurableOptionAvailableForSelection
  ],
  "variant": SimpleProduct
}

ConfigurableProductOptionsValues

Contains the index number assigned to a configurable product option.

Fields

Field NameDescription
default_label - String
The label of the product on the default store.
label - String
The label of the product.
store_label - String
The label of the product on the current store.
swatch_data - SwatchDataInterface
Swatch data for a configurable product option.
uid - ID
The unique ID for a `ConfigurableProductOptionsValues` object.
use_default_value - Boolean
Indicates whether to use the default_label.
value_index - Int
A unique index number assigned to the configurable product option. (Deprecated: Use `uid` instead.)

Example

Copied to your clipboard
{
  "default_label": "abc123",
  "label": "abc123",
  "store_label": "xyz789",
  "swatch_data": SwatchDataInterface,
  "uid": "4",
  "use_default_value": true,
  "value_index": 987
}

ConfigurableRequisitionListItem

Contains details about configurable products added to a requisition list.

Fields

Field NameDescription
configurable_options - [SelectedConfigurableOption]
Selected configurable options for an item in the requisition list.
customizable_options - [SelectedCustomizableOption]!
Selected custom options for an item in the requisition list.
product - ProductInterface!
Details about a requisition list item.
quantity - Float!
The quantity of the product added to the requisition list.
uid - ID!
The unique ID of an item in a requisition list.

Example

Copied to your clipboard
{
  "configurable_options": [SelectedConfigurableOption],
  "customizable_options": [SelectedCustomizableOption],
  "product": ProductInterface,
  "quantity": 123.45,
  "uid": 4
}

ConfigurableVariant

Contains all the simple product variants of a configurable product.

Fields

Field NameDescription
attributes - [ConfigurableAttributeOption]
An array of configurable attribute options.
product - SimpleProduct
An array of linked simple products.

Example

Copied to your clipboard
{
  "attributes": [ConfigurableAttributeOption],
  "product": SimpleProduct
}

ConfigurableWishlistItem

A configurable product wish list item.

Fields

Field NameDescription
added_at - String!
The date and time the item was added to the wish list.
child_sku - String!
The SKU of the simple product corresponding to a set of selected configurable options. (Deprecated: Use `ConfigurableWishlistItem.configured_variant.sku` instead.)
configurable_options - [SelectedConfigurableOption]
An array of selected configurable options.
configured_variant - ProductInterface
Product details of the selected variant. The value is null if some options are not configured.
customizable_options - [SelectedCustomizableOption]!
Custom options selected for the wish list item.
description - String
The description of the item.
id - ID!
The unique ID for a `WishlistItemInterface` object.
product - ProductInterface
Product details of the wish list item.
quantity - Float!
The quantity of this wish list item.

Example

Copied to your clipboard
{
  "added_at": "abc123",
  "child_sku": "xyz789",
  "configurable_options": [SelectedConfigurableOption],
  "configured_variant": ProductInterface,
  "customizable_options": [SelectedCustomizableOption],
  "description": "abc123",
  "id": "4",
  "product": ProductInterface,
  "quantity": 987.65
}

ConfirmCancelOrderInput

Input Fields

Input FieldDescription
confirmation_key - String!
Confirmation Key to cancel the order.
order_id - ID!
The unique ID of an `Order` type.

Example

Copied to your clipboard
{
  "confirmation_key": "abc123",
  "order_id": "4"
}

ConfirmEmailInput

Contains details about a customer email address to confirm.

Input Fields

Input FieldDescription
confirmation_key - String!
The key to confirm the email address.
email - String!
The email address to be confirmed.

Example

Copied to your clipboard
{
  "confirmation_key": "xyz789",
  "email": "xyz789"
}

ConfirmReturnInput

Input Fields

Input FieldDescription
confirmation_key - String!
Confirmation Key to return order.
order_id - ID!
The unique ID of an `Order` type.

Example

Copied to your clipboard
{
  "confirmation_key": "xyz789",
  "order_id": 4
}

ConfirmationStatusEnum

List of account confirmation statuses.

Values

Enum ValueDescription
ACCOUNT_CONFIRMED
Account confirmed
ACCOUNT_CONFIRMATION_NOT_REQUIRED
Account confirmation not required

Example

Copied to your clipboard
""ACCOUNT_CONFIRMED""

ContactUsInput

Input Fields

Input FieldDescription
comment - String!
The shopper's comment to the merchant.
email - String!
The email address of the shopper.
name - String!
The full name of the shopper.
telephone - String
The shopper's telephone number.

Example

Copied to your clipboard
{
  "comment": "abc123",
  "email": "xyz789",
  "name": "xyz789",
  "telephone": "abc123"
}

ContactUsOutput

Contains the status of the request.

Fields

Field NameDescription
status - Boolean!
Indicates whether the request was successful.

Example

Copied to your clipboard
{"status": true}

CopyItemsBetweenRequisitionListsInput

An input object that defines the items in a requisition list to be copied.

Input Fields

Input FieldDescription
requisitionListItemUids - [ID]!
An array of IDs representing products copied from one requisition list to another.

Example

Copied to your clipboard
{"requisitionListItemUids": [4]}

CopyItemsFromRequisitionListsOutput

Output of the request to copy items to the destination requisition list.

Fields

Field NameDescription
requisition_list - RequisitionList
The destination requisition list after the items were copied.

Example

Copied to your clipboard
{"requisition_list": RequisitionList}

CopyProductsBetweenWishlistsOutput

Contains the source and target wish lists after copying products.

Fields

Field NameDescription
destination_wishlist - Wishlist!
The destination wish list containing the copied products.
source_wishlist - Wishlist!
The wish list that the products were copied from.
user_errors - [WishListUserInputError]!
An array of errors encountered while copying products in a wish list.

Example

Copied to your clipboard
{
  "destination_wishlist": Wishlist,
  "source_wishlist": Wishlist,
  "user_errors": [WishListUserInputError]
}

Country

Fields

Field NameDescription
available_regions - [Region]
An array of regions within a particular country.
full_name_english - String
The name of the country in English.
full_name_locale - String
The name of the country in the current locale.
id - String
The unique ID for a `Country` object.
three_letter_abbreviation - String
The three-letter abbreviation of the country, such as USA.
two_letter_abbreviation - String
The two-letter abbreviation of the country, such as US.

Example

Copied to your clipboard
{
  "available_regions": [Region],
  "full_name_english": "xyz789",
  "full_name_locale": "xyz789",
  "id": "abc123",
  "three_letter_abbreviation": "abc123",
  "two_letter_abbreviation": "abc123"
}

CountryCodeEnum

The list of country codes.

Values

Enum ValueDescription
AF
Afghanistan
AX
Åland Islands
AL
Albania
DZ
Algeria
AS
American Samoa
AD
Andorra
AO
Angola
AI
Anguilla
AQ
Antarctica
AG
Antigua & Barbuda
AR
Argentina
AM
Armenia
AW
Aruba
AU
Australia
AT
Austria
AZ
Azerbaijan
BS
Bahamas
BH
Bahrain
BD
Bangladesh
BB
Barbados
BY
Belarus
BE
Belgium
BZ
Belize
BJ
Benin
BM
Bermuda
BT
Bhutan
BO
Bolivia
BA
Bosnia & Herzegovina
BW
Botswana
BV
Bouvet Island
BR
Brazil
IO
British Indian Ocean Territory
VG
British Virgin Islands
BN
Brunei
BG
Bulgaria
BF
Burkina Faso
BI
Burundi
KH
Cambodia
CM
Cameroon
CA
Canada
CV
Cape Verde
KY
Cayman Islands
CF
Central African Republic
TD
Chad
CL
Chile
CN
China
CX
Christmas Island
CC
Cocos (Keeling) Islands
CO
Colombia
KM
Comoros
CG
Congo-Brazzaville
CD
Congo-Kinshasa
CK
Cook Islands
CR
Costa Rica
CI
Côte d’Ivoire
HR
Croatia
CU
Cuba
CY
Cyprus
CZ
Czech Republic
DK
Denmark
DJ
Djibouti
DM
Dominica
DO
Dominican Republic
EC
Ecuador
EG
Egypt
SV
El Salvador
GQ
Equatorial Guinea
ER
Eritrea
EE
Estonia
SZ
Eswatini
ET
Ethiopia
FK
Falkland Islands
FO
Faroe Islands
FJ
Fiji
FI
Finland
FR
France
GF
French Guiana
PF
French Polynesia
TF
French Southern Territories
GA
Gabon
GM
Gambia
GE
Georgia
DE
Germany
GH
Ghana
GI
Gibraltar
GR
Greece
GL
Greenland
GD
Grenada
GP
Guadeloupe
GU
Guam
GT
Guatemala
GG
Guernsey
GN
Guinea
GW
Guinea-Bissau
GY
Guyana
HT
Haiti
HM
Heard &amp; McDonald Islands
HN
Honduras
HK
Hong Kong SAR China
HU
Hungary
IS
Iceland
IN
India
ID
Indonesia
IR
Iran
IQ
Iraq
IE
Ireland
IM
Isle of Man
IL
Israel
IT
Italy
JM
Jamaica
JP
Japan
JE
Jersey
JO
Jordan
KZ
Kazakhstan
KE
Kenya
KI
Kiribati
KW
Kuwait
KG
Kyrgyzstan
LA
Laos
LV
Latvia
LB
Lebanon
LS
Lesotho
LR
Liberia
LY
Libya
LI
Liechtenstein
LT
Lithuania
LU
Luxembourg
MO
Macau SAR China
MK
Macedonia
MG
Madagascar
MW
Malawi
MY
Malaysia
MV
Maldives
ML
Mali
MT
Malta
MH
Marshall Islands
MQ
Martinique
MR
Mauritania
MU
Mauritius
YT
Mayotte
MX
Mexico
FM
Micronesia
MD
Moldova
MC
Monaco
MN
Mongolia
ME
Montenegro
MS
Montserrat
MA
Morocco
MZ
Mozambique
MM
Myanmar (Burma)
NA
Namibia
NR
Nauru
NP
Nepal
NL
Netherlands
AN
Netherlands Antilles
NC
New Caledonia
NZ
New Zealand
NI
Nicaragua
NE
Niger
NG
Nigeria
NU
Niue
NF
Norfolk Island
MP
Northern Mariana Islands
KP
North Korea
NO
Norway
OM
Oman
PK
Pakistan
PW
Palau
PS
Palestinian Territories
PA
Panama
PG
Papua New Guinea
PY
Paraguay
PE
Peru
PH
Philippines
PN
Pitcairn Islands
PL
Poland
PT
Portugal
QA
Qatar
RE
Réunion
RO
Romania
RU
Russia
RW
Rwanda
WS
Samoa
SM
San Marino
ST
São Tomé & Príncipe
SA
Saudi Arabia
SN
Senegal
RS
Serbia
SC
Seychelles
SL
Sierra Leone
SG
Singapore
SK
Slovakia
SI
Slovenia
SB
Solomon Islands
SO
Somalia
ZA
South Africa
GS
South Georgia & South Sandwich Islands
KR
South Korea
ES
Spain
LK
Sri Lanka
BL
St. Barthélemy
SH
St. Helena
KN
St. Kitts & Nevis
LC
St. Lucia
MF
St. Martin
PM
St. Pierre & Miquelon
VC
St. Vincent & Grenadines
SD
Sudan
SR
Suriname
SJ
Svalbard & Jan Mayen
SE
Sweden
CH
Switzerland
SY
Syria
TW
Taiwan
TJ
Tajikistan
TZ
Tanzania
TH
Thailand
TL
Timor-Leste
TG
Togo
TK
Tokelau
TO
Tonga
TT
Trinidad & Tobago
TN
Tunisia
TR
Turkey
TM
Turkmenistan
TC
Turks & Caicos Islands
TV
Tuvalu
UG
Uganda
UA
Ukraine
AE
United Arab Emirates
GB
United Kingdom
US
United States
UY
Uruguay
UM
U.S. Outlying Islands
VI
U.S. Virgin Islands
UZ
Uzbekistan
VU
Vanuatu
VA
Vatican City
VE
Venezuela
VN
Vietnam
WF
Wallis & Futuna
EH
Western Sahara
YE
Yemen
ZM
Zambia
ZW
Zimbabwe

Example

Copied to your clipboard
""AF""

CreateCompanyOutput

Contains the response to the request to create a company.

Fields

Field NameDescription
company - Company!
The new company instance.

Example

Copied to your clipboard
{"company": Company}

CreateCompanyRoleOutput

Contains the response to the request to create a company role.

Fields

Field NameDescription
role - CompanyRole!
The new company role instance.

Example

Copied to your clipboard
{"role": CompanyRole}

CreateCompanyTeamOutput

Contains the response to the request to create a company team.

Fields

Field NameDescription
team - CompanyTeam!
The new company team instance.

Example

Copied to your clipboard
{"team": CompanyTeam}

CreateCompanyUserOutput

Contains the response to the request to create a company user.

Fields

Field NameDescription
user - Customer!
The new company user instance.

Example

Copied to your clipboard
{"user": Customer}

CreateCompareListInput

Contains an array of product IDs to use for creating a compare list.

Input Fields

Input FieldDescription
products - [ID]
An array of product IDs to add to the compare list.

Example

Copied to your clipboard
{"products": ["4"]}

CreateGiftRegistryInput

Defines a new gift registry.

Input Fields

Input FieldDescription
dynamic_attributes - [GiftRegistryDynamicAttributeInput]
Additional attributes specified as a code-value pair.
event_name - String!
The name of the event.
gift_registry_type_uid - ID!
The ID of the selected event type.
message - String!
A message describing the event.
privacy_settings - GiftRegistryPrivacySettings!
Indicates whether the registry is PRIVATE or PUBLIC.
registrants - [AddGiftRegistryRegistrantInput]!
The list of people who receive notifications about the registry.
shipping_address - GiftRegistryShippingAddressInput
The shipping address for all gift registry items.
status - GiftRegistryStatus!
Indicates whether the registry is ACTIVE or INACTIVE.

Example

Copied to your clipboard
{
  "dynamic_attributes": [
    GiftRegistryDynamicAttributeInput
  ],
  "event_name": "abc123",
  "gift_registry_type_uid": 4,
  "message": "xyz789",
  "privacy_settings": "PRIVATE",
  "registrants": [AddGiftRegistryRegistrantInput],
  "shipping_address": GiftRegistryShippingAddressInput,
  "status": "ACTIVE"
}

CreateGiftRegistryOutput

Contains the results of a request to create a gift registry.

Fields

Field NameDescription
gift_registry - GiftRegistry
The newly-created gift registry.

Example

Copied to your clipboard
{"gift_registry": GiftRegistry}

CreateGuestCartInput

Input Fields

Input FieldDescription
cart_uid - ID
Optional client-generated ID

Example

Copied to your clipboard
{"cart_uid": 4}

CreateGuestCartOutput

Fields

Field NameDescription
cart - Cart
The newly created cart.

Example

Copied to your clipboard
{"cart": Cart}

CreatePayflowProTokenOutput

Contains the secure information used to authorize transaction. Applies to Payflow Pro and Payments Pro payment methods.

Fields

Field NameDescription
response_message - String!
The RESPMSG returned by PayPal. If the `result` is `0`, then `response_message` is `Approved`.
result - Int!
A non-zero value if any errors occurred.
result_code - Int!
The RESULT returned by PayPal. A value of `0` indicates the transaction was approved.
secure_token - String!
A secure token generated by PayPal.
secure_token_id - String!
A secure token ID generated by PayPal.

Example

Copied to your clipboard
{
  "response_message": "xyz789",
  "result": 987,
  "result_code": 987,
  "secure_token": "abc123",
  "secure_token_id": "xyz789"
}

CreatePaymentOrderInput

Contains payment order details that are used while processing the payment order

Input Fields

Input FieldDescription
cartId - String!
The customer cart ID
location - PaymentLocation!
Defines the origin location for that payment request
methodCode - String!
The code for the payment method used in the order
paymentSource - String!
The identifiable payment source for the payment method
vaultIntent - Boolean
Indicates whether the payment information should be vaulted

Example

Copied to your clipboard
{
  "cartId": "xyz789",
  "location": "PRODUCT_DETAIL",
  "methodCode": "abc123",
  "paymentSource": "abc123",
  "vaultIntent": true
}

CreatePaymentOrderOutput

Contains payment order details that are used while processing the payment order

Fields

Field NameDescription
amount - Float
The amount of the payment order
currency_code - String
The currency of the payment order
id - String
PayPal order ID
mp_order_id - String
The order ID generated by Payment Services
status - String
The status of the payment order

Example

Copied to your clipboard
{
  "amount": 987.65,
  "currency_code": "abc123",
  "id": "xyz789",
  "mp_order_id": "xyz789",
  "status": "xyz789"
}

CreateProductReviewInput

Defines a new product review.

Input Fields

Input FieldDescription
nickname - String!
The customer's nickname. Defaults to the customer name, if logged in.
ratings - [ProductReviewRatingInput]!
The ratings details by category. For example, Price: 5 stars, Quality: 4 stars, etc.
sku - String!
The SKU of the reviewed product.
summary - String!
The summary (title) of the review.
text - String!
The review text.

Example

Copied to your clipboard
{
  "nickname": "abc123",
  "ratings": [ProductReviewRatingInput],
  "sku": "xyz789",
  "summary": "xyz789",
  "text": "xyz789"
}

CreateProductReviewOutput

Contains the completed product review.

Fields

Field NameDescription
review - ProductReview!
Product review details.

Example

Copied to your clipboard
{"review": ProductReview}

CreatePurchaseOrderApprovalRuleConditionAmountInput

Specifies the amount and currency to evaluate.

Input Fields

Input FieldDescription
currency - CurrencyEnum!
Purchase order approval rule condition amount currency.
value - Float!
Purchase order approval rule condition amount value.

Example

Copied to your clipboard
{"currency": "AFN", "value": 987.65}

CreatePurchaseOrderApprovalRuleConditionInput

Defines a set of conditions that apply to a rule.

Input Fields

Input FieldDescription
amount - CreatePurchaseOrderApprovalRuleConditionAmountInput
The amount to be compared in a purchase order approval rule. This field is mutually exclusive with condition quantity.
attribute - PurchaseOrderApprovalRuleType!
The type of approval rule.
operator - PurchaseOrderApprovalRuleConditionOperator!
Defines how to evaluate an amount or quantity in a purchase order.
quantity - Int
The quantity to be compared in a purchase order approval rule. This field is mutually exclusive with condition amount.

Example

Copied to your clipboard
{
  "amount": CreatePurchaseOrderApprovalRuleConditionAmountInput,
  "attribute": "GRAND_TOTAL",
  "operator": "MORE_THAN",
  "quantity": 987
}

CreateRequisitionListInput

An input object that identifies and describes a new requisition list.

Input Fields

Input FieldDescription
description - String
An optional description of the requisition list.
name - String!
The name assigned to the requisition list.

Example

Copied to your clipboard
{
  "description": "xyz789",
  "name": "abc123"
}

CreateRequisitionListOutput

Output of the request to create a requisition list.

Fields

Field NameDescription
requisition_list - RequisitionList
The created requisition list.

Example

Copied to your clipboard
{"requisition_list": RequisitionList}

CreateVaultCardPaymentTokenInput

Describe the variables needed to create a vault payment token

Input Fields

Input FieldDescription
card_description - String
Description of the vaulted card
setup_token_id - String!
The setup token obtained by the createVaultCardSetupToken endpoint

Example

Copied to your clipboard
{
  "card_description": "abc123",
  "setup_token_id": "xyz789"
}

CreateVaultCardPaymentTokenOutput

The vault token id and information about the payment source

Fields

Field NameDescription
payment_source - PaymentSourceOutput!
The payment source information
vault_token_id - String!
The vault payment token information

Example

Copied to your clipboard
{
  "payment_source": PaymentSourceOutput,
  "vault_token_id": "xyz789"
}

CreateVaultCardSetupTokenInput

Describe the variables needed to create a vault card setup token

Input Fields

Input FieldDescription
setup_token - VaultSetupTokenInput!
The setup token information
three_ds_mode - ThreeDSMode
The 3DS mode

Example

Copied to your clipboard
{
  "setup_token": VaultSetupTokenInput,
  "three_ds_mode": "OFF"
}

CreateVaultCardSetupTokenOutput

The setup token id information

Fields

Field NameDescription
setup_token - String!
The setup token id

Example

Copied to your clipboard
{"setup_token": "xyz789"}

CreateWishlistInput

Defines the name and visibility of a new wish list.

Input Fields

Input FieldDescription
name - String!
The name of the new wish list.
visibility - WishlistVisibilityEnum!
Indicates whether the wish list is public or private.

Example

Copied to your clipboard
{"name": "abc123", "visibility": "PUBLIC"}

CreateWishlistOutput

Contains the wish list.

Fields

Field NameDescription
wishlist - Wishlist!
The newly-created wish list

Example

Copied to your clipboard
{"wishlist": Wishlist}

CreditCardDetailsInput

Required fields for Payflow Pro and Payments Pro credit card payments.

Input Fields

Input FieldDescription
cc_exp_month - Int!
The credit card expiration month.
cc_exp_year - Int!
The credit card expiration year.
cc_last_4 - Int!
The last 4 digits of the credit card.
cc_type - String!
The credit card type.

Example

Copied to your clipboard
{
  "cc_exp_month": 123,
  "cc_exp_year": 987,
  "cc_last_4": 987,
  "cc_type": "abc123"
}

CreditMemo

Contains credit memo details.

Fields

Field NameDescription
comments - [SalesCommentItem]
Comments on the credit memo.
id - ID!
The unique ID for a `CreditMemo` object.
items - [CreditMemoItemInterface]
An array containing details about refunded items.
number - String!
The sequential credit memo number.
total - CreditMemoTotal
Details about the total refunded amount.

Example

Copied to your clipboard
{
  "comments": [SalesCommentItem],
  "id": 4,
  "items": [CreditMemoItemInterface],
  "number": "abc123",
  "total": CreditMemoTotal
}

CreditMemoItem

Fields

Field NameDescription
discounts - [Discount]
Details about the final discount amount for the base product, including discounts on options.
id - ID!
The unique ID for a `CreditMemoItemInterface` object.
order_item - OrderItemInterface
The order item the credit memo is applied to.
product_name - String
The name of the base product.
product_sale_price - Money!
The sale price for the base product, including selected options.
product_sku - String!
The SKU of the base product.
quantity_refunded - Float
The number of refunded items.

Example

Copied to your clipboard
{
  "discounts": [Discount],
  "id": 4,
  "order_item": OrderItemInterface,
  "product_name": "xyz789",
  "product_sale_price": Money,
  "product_sku": "xyz789",
  "quantity_refunded": 123.45
}

CreditMemoItemInterface

Credit memo item details.

Fields

Field NameDescription
discounts - [Discount]
Details about the final discount amount for the base product, including discounts on options.
id - ID!
The unique ID for a `CreditMemoItemInterface` object.
order_item - OrderItemInterface
The order item the credit memo is applied to.
product_name - String
The name of the base product.
product_sale_price - Money!
The sale price for the base product, including selected options.
product_sku - String!
The SKU of the base product.
quantity_refunded - Float
The number of refunded items.

Possible Types

CreditMemoItemInterface Types
DownloadableCreditMemoItem
BundleCreditMemoItem
GiftCardCreditMemoItem
CreditMemoItem

Example

Copied to your clipboard
{
  "discounts": [Discount],
  "id": "4",
  "order_item": OrderItemInterface,
  "product_name": "xyz789",
  "product_sale_price": Money,
  "product_sku": "abc123",
  "quantity_refunded": 123.45
}

CreditMemoTotal

Contains credit memo price details.

Fields

Field NameDescription
adjustment - Money!
An adjustment manually applied to the order.
base_grand_total - Money!
The final base grand total amount in the base currency.
discounts - [Discount]
The applied discounts to the credit memo.
grand_total - Money!
The final total amount, including shipping, discounts, and taxes.
shipping_handling - ShippingHandling
Details about the shipping and handling costs for the credit memo.
subtotal - Money!
The subtotal of the invoice, excluding shipping, discounts, and taxes.
taxes - [TaxItem]
The credit memo tax details.
total_shipping - Money!
The shipping amount for the credit memo.
total_tax - Money!
The amount of tax applied to the credit memo.

Example

Copied to your clipboard
{
  "adjustment": Money,
  "base_grand_total": Money,
  "discounts": [Discount],
  "grand_total": Money,
  "shipping_handling": ShippingHandling,
  "subtotal": Money,
  "taxes": [TaxItem],
  "total_shipping": Money,
  "total_tax": Money
}

Currency

Fields

Field NameDescription
available_currency_codes - [String]
An array of three-letter currency codes accepted by the store, such as USD and EUR.
base_currency_code - String
The base currency set for the store, such as USD.
base_currency_symbol - String
The symbol for the specified base currency, such as $.
default_display_currecy_code - String
(Deprecated: Symbol was missed. Use `default_display_currency_code`.)
default_display_currecy_symbol - String
(Deprecated: Symbol was missed. Use `default_display_currency_code`.)
default_display_currency_code - String
The currency that is displayed by default, such as USD.
default_display_currency_symbol - String
The currency symbol that is displayed by default, such as $.
exchange_rates - [ExchangeRate]
An array of exchange rates for currencies defined in the store.

Example

Copied to your clipboard
{
  "available_currency_codes": ["abc123"],
  "base_currency_code": "abc123",
  "base_currency_symbol": "xyz789",
  "default_display_currecy_code": "xyz789",
  "default_display_currecy_symbol": "abc123",
  "default_display_currency_code": "abc123",
  "default_display_currency_symbol": "xyz789",
  "exchange_rates": [ExchangeRate]
}

CurrencyEnum

The list of available currency codes.

Values

Enum ValueDescription
AFN
ALL
AZN
DZD
AOA
ARS
AMD
AWG
AUD
BSD
BHD
BDT
BBD
BYN
BZD
BMD
BTN
BOB
BAM
BWP
BRL
GBP
BND
BGN
BUK
BIF
KHR
CAD
CVE
CZK
KYD
GQE
CLP
CNY
COP
KMF
CDF
CRC
HRK
CUP
DKK
DJF
DOP
XCD
EGP
SVC
ERN
EEK
ETB
EUR
FKP
FJD
GMD
GEK
GEL
GHS
GIP
GTQ
GNF
GYD
HTG
HNL
HKD
HUF
ISK
INR
IDR
IRR
IQD
ILS
JMD
JPY
JOD
KZT
KES
KWD
KGS
LAK
LVL
LBP
LSL
LRD
LYD
LTL
MOP
MKD
MGA
MWK
MYR
MVR
LSM
MRO
MUR
MXN
MDL
MNT
MAD
MZN
MMK
NAD
NPR
ANG
YTL
NZD
NIC
NGN
KPW
NOK
OMR
PKR
PAB
PGK
PYG
PEN
PHP
PLN
QAR
RHD
RON
RUB
RWF
SHP
STD
SAR
RSD
SCR
SLL
SGD
SKK
SBD
SOS
ZAR
KRW
LKR
SDG
SRD
SZL
SEK
CHF
SYP
TWD
TJS
TZS
THB
TOP
TTD
TND
TMM
USD
UGX
UAH
AED
UYU
UZS
VUV
VEB
VEF
VND
CHE
CHW
XOF
WST
YER
ZMK
ZWD
TRY
AZM
ROL
TRL
XPF

Example

Copied to your clipboard
""AFN""

CustomAttributeMetadata

Defines an array of custom attributes.

Fields

Field NameDescription
items - [Attribute]
An array of attributes.

Example

Copied to your clipboard
{"items": [Attribute]}

CustomAttributeMetadataInterface

An interface containing fields that define the EAV attribute.

Fields

Field NameDescription
code - ID!
The unique identifier for an attribute code. This value should be in lowercase letters without spaces.
default_value - String
Default attribute value.
entity_type - AttributeEntityTypeEnum!
The type of entity that defines the attribute.
frontend_class - String
The frontend class of the attribute.
frontend_input - AttributeFrontendInputEnum
The frontend input type of the attribute.
is_required - Boolean!
Whether the attribute value is required.
is_unique - Boolean!
Whether the attribute value must be unique.
label - String
The label assigned to the attribute.
options - [CustomAttributeOptionInterface]!
Attribute options.

Possible Types

CustomAttributeMetadataInterface Types
AttributeMetadata
CatalogAttributeMetadata
CustomerAttributeMetadata
ReturnItemAttributeMetadata

Example

Copied to your clipboard
{
  "code": "4",
  "default_value": "abc123",
  "entity_type": "CATALOG_PRODUCT",
  "frontend_class": "abc123",
  "frontend_input": "BOOLEAN",
  "is_required": true,
  "is_unique": true,
  "label": "xyz789",
  "options": [CustomAttributeOptionInterface]
}

CustomAttributeOptionInterface

Fields

Field NameDescription
is_default - Boolean!
Is the option value default.
label - String!
The label assigned to the attribute option.
value - String!
The attribute option value.

Possible Types

CustomAttributeOptionInterface Types
AttributeOptionMetadata

Example

Copied to your clipboard
{
  "is_default": true,
  "label": "abc123",
  "value": "xyz789"
}

Customer

Defines the customer name, addresses, and other details.

Fields

Field NameDescription
addresses - [CustomerAddress]
An array containing the customer's shipping and billing addresses.
addressesV2 - CustomerAddresses
An array containing the customer's shipping and billing addresses.
allow_remote_shopping_assistance - Boolean!
Indicates whether the customer has enabled remote shopping assistance.
companies - UserCompaniesOutput!
An object that contains a list of companies user is assigned to.
compare_list - CompareList
The contents of the customer's compare list.
confirmation_status - ConfirmationStatusEnum!
The customer's confirmation status.
created_at - String
Timestamp indicating when the account was created.
custom_attributes - [AttributeValueInterface]
Customer's custom attributes.
date_of_birth - String
The customer's date of birth.
default_billing - String
The ID assigned to the billing address.
default_shipping - String
The ID assigned to the shipping address.
dob - String
The customer's date of birth. (Deprecated: Use `date_of_birth` instead.)
email - String
The customer's email address. Required.
firstname - String
The customer's first name.
gender - Int
The customer's gender (Male - 1, Female - 2).
gift_registries - [GiftRegistry]
Details about all of the customer's gift registries.
gift_registry - GiftRegistry
Details about a specific gift registry.
group - CustomerGroupStorefront
Customer group assigned to the customer
group_id - Int
(Deprecated: Customer group should not be exposed in the storefront scenarios.)
id - ID!
The unique ID assigned to the customer.
is_subscribed - Boolean
Indicates whether the customer is subscribed to the company's newsletter.
job_title - String
The job title of a company user.
lastname - String
The customer's family name.
middlename - String
The customer's middle name.
orders - CustomerOrders
prefix - String
An honorific, such as Dr., Mr., or Mrs.
purchase_order - PurchaseOrder
Purchase order details.
purchase_order_approval_rule - PurchaseOrderApprovalRule
Details about a single purchase order approval rule.
purchase_order_approval_rule_metadata - PurchaseOrderApprovalRuleMetadata
Purchase order approval rule metadata that can be used for rule edit form rendering.
purchase_order_approval_rules - PurchaseOrderApprovalRules
A list of purchase order approval rules visible to the customer.
purchase_orders - PurchaseOrders
A list of purchase orders visible to the customer.
purchase_orders_enabled - Boolean!
Indicates whether purchase order functionality is enabled for the current customer. Global and company-level settings are factored into the result.
requisition_lists - RequisitionLists
An object that contains the customer's requisition lists.
return - Return
Details about the specified return request from the unique ID for a `Return` object.
returns - Returns
Information about the customer's return requests.
reviews - ProductReviews!
Contains the customer's product reviews.
reward_points - RewardPoints
Customer reward points details.
role - CompanyRole
The role name and permissions assigned to the company user.
segments - [CustomerSegmentStorefront]
Customer segments associated with the current customer
status - CompanyUserStatusEnum
Indicates whether the company user is ACTIVE or INACTIVE.
store_credit - CustomerStoreCredit
Store credit information applied for the logged in customer.
structure_id - ID!
ID of the company structure
suffix - String
A value such as Sr., Jr., or III.
taxvat - String
The customer's Value-added tax (VAT) number (for corporate customers).
team - CompanyTeam
The team the company user is assigned to.
telephone - String
The phone number of the company user.
wishlist - Wishlist!
Return a customer's wish lists. (Deprecated: Use `Customer.wishlists` or `Customer.wishlist_v2` instead.)
wishlist_v2 - Wishlist
Retrieve the wish list identified by the unique ID for a `Wishlist` object.
wishlists - [Wishlist]!
An array of wishlists. In Magento Open Source, customers are limited to one wish list. The number of wish lists is configurable for Adobe Commerce.

Example

Copied to your clipboard
{
  "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",
  "dob": "xyz789",
  "email": "abc123",
  "firstname": "abc123",
  "gender": 123,
  "gift_registries": [GiftRegistry],
  "gift_registry": GiftRegistry,
  "group": CustomerGroupStorefront,
  "group_id": 123,
  "id": "4",
  "is_subscribed": true,
  "job_title": "xyz789",
  "lastname": "abc123",
  "middlename": "abc123",
  "orders": CustomerOrders,
  "prefix": "abc123",
  "purchase_order": PurchaseOrder,
  "purchase_order_approval_rule": PurchaseOrderApprovalRule,
  "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata,
  "purchase_order_approval_rules": PurchaseOrderApprovalRules,
  "purchase_orders": PurchaseOrders,
  "purchase_orders_enabled": true,
  "requisition_lists": RequisitionLists,
  "return": Return,
  "returns": Returns,
  "reviews": ProductReviews,
  "reward_points": RewardPoints,
  "role": CompanyRole,
  "segments": [CustomerSegmentStorefront],
  "status": "ACTIVE",
  "store_credit": CustomerStoreCredit,
  "structure_id": 4,
  "suffix": "xyz789",
  "taxvat": "xyz789",
  "team": CompanyTeam,
  "telephone": "abc123",
  "wishlist": Wishlist,
  "wishlist_v2": Wishlist,
  "wishlists": [Wishlist]
}

CustomerAddress

Contains detailed information about a customer's billing or shipping address.

Fields

Field NameDescription
city - String
The customer's city or town.
company - String
The customer's company.
country_code - CountryCodeEnum
The customer's country.
country_id - String
The customer's country. (Deprecated: Use `country_code` instead.)
custom_attributes - [CustomerAddressAttribute]
(Deprecated: Use custom_attributesV2 instead.)
custom_attributesV2 - [AttributeValueInterface]!
Custom attributes assigned to the customer address.
customer_id - Int
The customer ID (Deprecated: `customer_id` is not needed as part of `CustomerAddress`. The `id` is a unique identifier for the addresses.)
default_billing - Boolean
Indicates whether the address is the customer's default billing address.
default_shipping - Boolean
Indicates whether the address is the customer's default shipping address.
extension_attributes - [CustomerAddressAttribute]
Contains any extension attributes for the address.
fax - String
The customer's fax number.
firstname - String
The first name of the person associated with the shipping/billing address.
id - Int
The ID of a `CustomerAddress` object. (Deprecated: Use `uid` instead.)
lastname - String
The family name of the person associated with the shipping/billing address.
middlename - String
The middle name of the person associated with the shipping/billing address.
postcode - String
The customer's ZIP or postal code.
prefix - String
An honorific, such as Dr., Mr., or Mrs.
region - CustomerAddressRegion
An object containing the region name, region code, and region ID.
region_id - Int
The unique ID for a pre-defined region.
street - [String]
An array of strings that define the street number and name.
suffix - String
A value such as Sr., Jr., or III.
telephone - String
The customer's telephone number.
uid - ID
The unique ID for a `CustomerAddress` object.
vat_id - String
The customer's Value-added tax (VAT) number (for corporate customers).

Example

Copied to your clipboard
{
  "city": "xyz789",
  "company": "abc123",
  "country_code": "AF",
  "country_id": "abc123",
  "custom_attributes": [CustomerAddressAttribute],
  "custom_attributesV2": [AttributeValueInterface],
  "customer_id": 987,
  "default_billing": false,
  "default_shipping": false,
  "extension_attributes": [CustomerAddressAttribute],
  "fax": "abc123",
  "firstname": "abc123",
  "id": 987,
  "lastname": "xyz789",
  "middlename": "abc123",
  "postcode": "xyz789",
  "prefix": "abc123",
  "region": CustomerAddressRegion,
  "region_id": 987,
  "street": ["xyz789"],
  "suffix": "abc123",
  "telephone": "abc123",
  "uid": 4,
  "vat_id": "abc123"
}

CustomerAddressAttribute

Specifies the attribute code and value of a customer address attribute.

Fields

Field NameDescription
attribute_code - String
The name assigned to the customer address attribute.
value - String
The value assigned to the customer address attribute.

Example

Copied to your clipboard
{
  "attribute_code": "abc123",
  "value": "abc123"
}

CustomerAddressAttributeInput

Specifies the attribute code and value of a customer attribute.

Input Fields

Input FieldDescription
attribute_code - String!
The name assigned to the attribute.
value - String!
The value assigned to the attribute.

Example

Copied to your clipboard
{
  "attribute_code": "xyz789",
  "value": "abc123"
}

CustomerAddressInput

Contains details about a billing or shipping address.

Input Fields

Input FieldDescription
city - String
The customer's city or town.
company - String
The customer's company.
country_code - CountryCodeEnum
The two-letter code representing the customer's country.
country_id - CountryCodeEnum
custom_attributes - [CustomerAddressAttributeInput]
custom_attributesV2 - [AttributeValueInput]
Custom attributes assigned to the customer address.
default_billing - Boolean
Indicates whether the address is the default billing address.
default_shipping - Boolean
Indicates whether the address is the default shipping address.
fax - String
The customer's fax number.
firstname - String
The first name of the person associated with the billing/shipping address.
lastname - String
The family name of the person associated with the billing/shipping address.
middlename - String
The middle name of the person associated with the billing/shipping address.
postcode - String
The customer's ZIP or postal code.
prefix - String
An honorific, such as Dr., Mr., or Mrs.
region - CustomerAddressRegionInput
An object containing the region name, region code, and region ID.
street - [String]
An array of strings that define the street number and name.
suffix - String
A value such as Sr., Jr., or III.
telephone - String
The customer's telephone number.
vat_id - String
The customer's Tax/VAT number (for corporate customers).

Example

Copied to your clipboard
{
  "city": "xyz789",
  "company": "abc123",
  "country_code": "AF",
  "country_id": "AF",
  "custom_attributes": [CustomerAddressAttributeInput],
  "custom_attributesV2": [AttributeValueInput],
  "default_billing": true,
  "default_shipping": true,
  "fax": "xyz789",
  "firstname": "xyz789",
  "lastname": "abc123",
  "middlename": "xyz789",
  "postcode": "abc123",
  "prefix": "abc123",
  "region": CustomerAddressRegionInput,
  "street": ["xyz789"],
  "suffix": "xyz789",
  "telephone": "abc123",
  "vat_id": "abc123"
}

CustomerAddressRegion

Defines the customer's state or province.

Fields

Field NameDescription
region - String
The state or province name.
region_code - String
The address region code.
region_id - Int
The unique ID for a pre-defined region.

Example

Copied to your clipboard
{
  "region": "abc123",
  "region_code": "abc123",
  "region_id": 123
}

CustomerAddressRegionInput

Defines the customer's state or province.

Input Fields

Input FieldDescription
region - String
The state or province name.
region_code - String
The address region code.
region_id - Int
The unique ID for a pre-defined region.

Example

Copied to your clipboard
{
  "region": "xyz789",
  "region_code": "abc123",
  "region_id": 987
}

CustomerAddresses

Fields

Field NameDescription
items - [CustomerAddress]
An array containing the customer's shipping and billing addresses.
page_info - SearchResultPageInfo
Contains pagination metadata.
total_count - Int
The total count of customer addresses.

Example

Copied to your clipboard
{
  "items": [CustomerAddress],
  "page_info": SearchResultPageInfo,
  "total_count": 123
}

CustomerAttributeMetadata

Customer attribute metadata.

Fields

Field NameDescription
code - ID!
The unique identifier for an attribute code. This value should be in lowercase letters without spaces.
default_value - String
Default attribute value.
entity_type - AttributeEntityTypeEnum!
The type of entity that defines the attribute.
frontend_class - String
The frontend class of the attribute.
frontend_input - AttributeFrontendInputEnum
The frontend input type of the attribute.
input_filter - InputFilterEnum
The template used for the input of the attribute (e.g., 'date').
is_required - Boolean!
Whether the attribute value is required.
is_unique - Boolean!
Whether the attribute value must be unique.
label - String
The label assigned to the attribute.
multiline_count - Int
The number of lines of the attribute value.
options - [CustomAttributeOptionInterface]!
Attribute options.
sort_order - Int
The position of the attribute in the form.
validate_rules - [ValidationRule]
The validation rules of the attribute value.

Example

Copied to your clipboard
{
  "code": 4,
  "default_value": "abc123",
  "entity_type": "CATALOG_PRODUCT",
  "frontend_class": "abc123",
  "frontend_input": "BOOLEAN",
  "input_filter": "NONE",
  "is_required": false,
  "is_unique": true,
  "label": "abc123",
  "multiline_count": 987,
  "options": [CustomAttributeOptionInterface],
  "sort_order": 987,
  "validate_rules": [ValidationRule]
}

CustomerCreateInput

An input object for creating a customer.

Input Fields

Input FieldDescription
allow_remote_shopping_assistance - Boolean
Indicates whether the customer has enabled remote shopping assistance.
custom_attributes - [AttributeValueInput]
The customer's custom attributes.
date_of_birth - String
The customer's date of birth.
dob - String
email - String!
The customer's email address.
firstname - String!
The customer's first name.
gender - Int
The customer's gender (Male - 1, Female - 2).
is_subscribed - Boolean
Indicates whether the customer is subscribed to the company's newsletter.
lastname - String!
The customer's family name.
middlename - String
The customer's middle name.
password - String
The customer's password.
prefix - String
An honorific, such as Dr., Mr., or Mrs.
suffix - String
A value such as Sr., Jr., or III.
taxvat - String
The customer's Tax/VAT number (for corporate customers).

Example

Copied to your clipboard
{
  "allow_remote_shopping_assistance": false,
  "custom_attributes": [AttributeValueInput],
  "date_of_birth": "xyz789",
  "dob": "xyz789",
  "email": "abc123",
  "firstname": "xyz789",
  "gender": 987,
  "is_subscribed": true,
  "lastname": "xyz789",
  "middlename": "xyz789",
  "password": "xyz789",
  "prefix": "abc123",
  "suffix": "xyz789",
  "taxvat": "xyz789"
}

CustomerDownloadableProduct

Contains details about a single downloadable product.

Fields

Field NameDescription
date - String
The date and time the purchase was made.
download_url - String
The fully qualified URL to the download file.
order_increment_id - String
The unique ID assigned to the item.
remaining_downloads - String
The remaining number of times the customer can download the product.
status - String
Indicates when the product becomes available for download. Options are `Pending` and `Invoiced`.

Example

Copied to your clipboard
{
  "date": "abc123",
  "download_url": "abc123",
  "order_increment_id": "xyz789",
  "remaining_downloads": "abc123",
  "status": "xyz789"
}

CustomerDownloadableProducts

Contains a list of downloadable products.

Fields

Field NameDescription
items - [CustomerDownloadableProduct]
An array of purchased downloadable items.

Example

Copied to your clipboard
{"items": [CustomerDownloadableProduct]}

CustomerGroupStorefront

Data of customer group.

Fields

Field NameDescription
uid - ID!
The unique ID for a `CustomerGroup` object.

Example

Copied to your clipboard
{"uid": "4"}

CustomerInput

An input object that assigns or updates customer attributes.

Input Fields

Input FieldDescription
date_of_birth - String
The customer's date of birth.
dob - String
email - String
The customer's email address. Required when creating a customer.
firstname - String
The customer's first name.
gender - Int
The customer's gender (Male - 1, Female - 2).
is_subscribed - Boolean
Indicates whether the customer is subscribed to the company's newsletter.
lastname - String
The customer's family name.
middlename - String
The customer's middle name.
password - String
The customer's password.
prefix - String
An honorific, such as Dr., Mr., or Mrs.
suffix - String
A value such as Sr., Jr., or III.
taxvat - String
The customer's Tax/VAT number (for corporate customers).

Example

Copied to your clipboard
{
  "date_of_birth": "abc123",
  "dob": "xyz789",
  "email": "abc123",
  "firstname": "xyz789",
  "gender": 123,
  "is_subscribed": true,
  "lastname": "xyz789",
  "middlename": "abc123",
  "password": "abc123",
  "prefix": "xyz789",
  "suffix": "abc123",
  "taxvat": "abc123"
}

CustomerOrder

Contains details about each of the customer's orders.

Fields

Field NameDescription
applied_coupons - [AppliedCoupon]!
Coupons applied to the order.
applied_gift_cards - [ApplyGiftCardToOrder]
An array of gift cards applied to the order.
available_actions - [OrderActionType]!
List of available order actions.
billing_address - OrderAddress
The billing address for the order.
carrier - String
The shipping carrier for the order delivery.
comments - [SalesCommentItem]
Comments about the order.
created_at - String
(Deprecated: Use the `order_date` field instead.)
credit_memos - [CreditMemo]
A list of credit memos.
customer_info - OrderCustomerInfo!
Returns customer information from order.
email - String
Order customer email.
gift_message - GiftMessage
The entered gift message for the order
gift_receipt_included - Boolean!
Indicates whether the customer requested a gift receipt for the order.
gift_wrapping - GiftWrapping
The selected gift wrapping for the order.
grand_total - Float
(Deprecated: Use the `totals.grand_total` field instead.)
id - ID!
The unique ID for a `CustomerOrder` object.
increment_id - String
(Deprecated: Use the `id` field instead.)
invoices - [Invoice]!
A list of invoices for the order.
is_virtual - Boolean!
`TRUE` if the order is virtual
items - [OrderItemInterface]
An array containing the items purchased in this order.
items_eligible_for_return - [OrderItemInterface]
A list of order items eligible to be in a return request.
number - String!
The order number.
order_date - String!
The date the order was placed.
order_number - String!
(Deprecated: Use the `number` field instead.)
order_status_change_date - String!
The date the order status was last updated.
payment_methods - [OrderPaymentMethod]
Payment details for the order.
printed_card_included - Boolean!
Indicates whether the customer requested a printed card for the order.
returns - Returns
Return requests associated with this order.
shipments - [OrderShipment]
A list of shipments for the order.
shipping_address - OrderAddress
The shipping address for the order.
shipping_method - String
The delivery method for the order.
status - String!
The current status of the order.
token - String!
The token that can be used to retrieve the order using order query.
total - OrderTotal
Details about the calculated totals for this order.

Example

Copied to your clipboard
{
  "applied_coupons": [AppliedCoupon],
  "applied_gift_cards": [ApplyGiftCardToOrder],
  "available_actions": ["REORDER"],
  "billing_address": OrderAddress,
  "carrier": "abc123",
  "comments": [SalesCommentItem],
  "created_at": "abc123",
  "credit_memos": [CreditMemo],
  "customer_info": OrderCustomerInfo,
  "email": "xyz789",
  "gift_message": GiftMessage,
  "gift_receipt_included": false,
  "gift_wrapping": GiftWrapping,
  "grand_total": 123.45,
  "id": "4",
  "increment_id": "xyz789",
  "invoices": [Invoice],
  "is_virtual": false,
  "items": [OrderItemInterface],
  "items_eligible_for_return": [OrderItemInterface],
  "number": "abc123",
  "order_date": "xyz789",
  "order_number": "xyz789",
  "order_status_change_date": "xyz789",
  "payment_methods": [OrderPaymentMethod],
  "printed_card_included": false,
  "returns": Returns,
  "shipments": [OrderShipment],
  "shipping_address": OrderAddress,
  "shipping_method": "abc123",
  "status": "xyz789",
  "token": "abc123",
  "total": OrderTotal
}

CustomerOrderSortInput

CustomerOrderSortInput specifies the field to use for sorting search results and indicates whether the results are sorted in ascending or descending order.

Input Fields

Input FieldDescription
sort_direction - SortEnum!
This enumeration indicates whether to return results in ascending or descending order
sort_field - CustomerOrderSortableField!
Specifies the field to use for sorting

Example

Copied to your clipboard
{"sort_direction": "ASC", "sort_field": "NUMBER"}

CustomerOrderSortableField

Specifies the field to use for sorting

Values

Enum ValueDescription
NUMBER
Sorts customer orders by number
CREATED_AT
Sorts customer orders by created_at field

Example

Copied to your clipboard
""NUMBER""

CustomerOrders

The collection of orders that match the conditions defined in the filter.

Fields

Field NameDescription
date_of_first_order - String
Date of the first order placed in the store
items - [CustomerOrder]!
An array of customer orders.
page_info - SearchResultPageInfo
Contains pagination metadata.
total_count - Int
The total count of customer orders.

Example

Copied to your clipboard
{
  "date_of_first_order": "abc123",
  "items": [CustomerOrder],
  "page_info": SearchResultPageInfo,
  "total_count": 123
}

CustomerOrdersFilterInput

Identifies the filter to use for filtering orders.

Input Fields

Input FieldDescription
grand_total - FilterRangeTypeInput
Filters by order base grand total value.
number - FilterStringTypeInput
Filters by order number.
order_date - FilterRangeTypeInput
Filters by order created_at time.
status - FilterEqualTypeInput
Filters by order status.

Example

Copied to your clipboard
{
  "grand_total": FilterRangeTypeInput,
  "number": FilterStringTypeInput,
  "order_date": FilterRangeTypeInput,
  "status": FilterEqualTypeInput
}

CustomerOutput

Contains details about a newly-created or updated customer.

Fields

Field NameDescription
customer - Customer!
Customer details after creating or updating a customer.

Example

Copied to your clipboard
{"customer": Customer}

CustomerPaymentTokens

Contains payment tokens stored in the customer's vault.

Fields

Field NameDescription
items - [PaymentToken]!
An array of payment tokens.

Example

Copied to your clipboard
{"items": [PaymentToken]}

CustomerSegmentStorefront

Customer segment details

Fields

Field NameDescription
uid - ID!
The unique ID for a `CustomerSegment` object.

Example

Copied to your clipboard
{"uid": 4}

CustomerStoreCredit

Contains store credit information with balance and history.

Fields

Field NameDescription
balance_history - CustomerStoreCreditHistory
Contains the customer's store credit balance history. If the history or store credit feature is disabled, then a null value will be returned.
current_balance - Money
The current balance of store credit.
enabled - Boolean
Indicates whether store credits are enabled. If the feature is disabled, then the balance will not be returned.

Example

Copied to your clipboard
{
  "balance_history": CustomerStoreCreditHistory,
  "current_balance": Money,
  "enabled": true
}

CustomerStoreCreditHistory

Lists changes to the amount of store credit available to the customer.

Fields

Field NameDescription
items - [CustomerStoreCreditHistoryItem]
An array containing information about changes to the store credit available to the customer.
page_info - SearchResultPageInfo
Metadata for pagination rendering.
total_count - Int
The number of items returned.

Example

Copied to your clipboard
{
  "items": [CustomerStoreCreditHistoryItem],
  "page_info": SearchResultPageInfo,
  "total_count": 123
}

CustomerStoreCreditHistoryItem

Contains store credit history information.

Fields

Field NameDescription
action - String
The action that was made on the store credit.
actual_balance - Money
The store credit available to the customer as a result of this action.
balance_change - Money
The amount added to or subtracted from the store credit as a result of this action.
date_time_changed - String
The date and time when the store credit change was made.

Example

Copied to your clipboard
{
  "action": "xyz789",
  "actual_balance": Money,
  "balance_change": Money,
  "date_time_changed": "xyz789"
}

CustomerToken

Contains a customer authorization token.

Fields

Field NameDescription
token - String
The customer authorization token.

Example

Copied to your clipboard
{"token": "xyz789"}

CustomerUpdateInput

An input object for updating a customer.

Input Fields

Input FieldDescription
allow_remote_shopping_assistance - Boolean
Indicates whether the customer has enabled remote shopping assistance.
custom_attributes - [AttributeValueInput]
The customer's custom attributes.
date_of_birth - String
The customer's date of birth.
dob - String
firstname - String
The customer's first name.
gender - Int
The customer's gender (Male - 1, Female - 2).
is_subscribed - Boolean
Indicates whether the customer is subscribed to the company's newsletter.
lastname - String
The customer's family name.
middlename - String
The customer's middle name.
prefix - String
An honorific, such as Dr., Mr., or Mrs.
suffix - String
A value such as Sr., Jr., or III.
taxvat - String
The customer's Tax/VAT number (for corporate customers).

Example

Copied to your clipboard
{
  "allow_remote_shopping_assistance": false,
  "custom_attributes": [AttributeValueInput],
  "date_of_birth": "abc123",
  "dob": "abc123",
  "firstname": "abc123",
  "gender": 123,
  "is_subscribed": true,
  "lastname": "abc123",
  "middlename": "xyz789",
  "prefix": "xyz789",
  "suffix": "abc123",
  "taxvat": "xyz789"
}

CustomizableAreaOption

Contains information about a text area that is defined as part of a customizable option.

Fields

Field NameDescription
option_id - Int
Option ID. (Deprecated: Use `uid` instead)
product_sku - String
The Stock Keeping Unit of the base product.
required - Boolean
Indicates whether the option is required.
sort_order - Int
The order in which the option is displayed.
title - String
The display name for this option.
uid - ID!
The unique ID for a `CustomizableOptionInterface` object.
value - CustomizableAreaValue
An object that defines a text area.

Example

Copied to your clipboard
{
  "option_id": 987,
  "product_sku": "abc123",
  "required": false,
  "sort_order": 123,
  "title": "xyz789",
  "uid": 4,
  "value": CustomizableAreaValue
}

CustomizableAreaValue

Defines the price and sku of a product whose page contains a customized text area.

Fields

Field NameDescription
max_characters - Int
The maximum number of characters that can be entered for this customizable option.
price - Float
The price assigned to this option.
price_type - PriceTypeEnum
FIXED, PERCENT, or DYNAMIC.
sku - String
The Stock Keeping Unit for this option.
uid - ID!
The unique ID for a `CustomizableAreaValue` object.

Example

Copied to your clipboard
{
  "max_characters": 123,
  "price": 123.45,
  "price_type": "FIXED",
  "sku": "abc123",
  "uid": 4
}

CustomizableCheckboxOption

Contains information about a set of checkbox values that are defined as part of a customizable option.

Fields

Field NameDescription
option_id - Int
Option ID. (Deprecated: Use `uid` instead)
required - Boolean
Indicates whether the option is required.
sort_order - Int
The order in which the option is displayed.
title - String
The display name for this option.
uid - ID!
The unique ID for a `CustomizableOptionInterface` object.
value - [CustomizableCheckboxValue]
An array that defines a set of checkbox values.

Example

Copied to your clipboard
{
  "option_id": 123,
  "required": true,
  "sort_order": 123,
  "title": "abc123",
  "uid": 4,
  "value": [CustomizableCheckboxValue]
}

CustomizableCheckboxValue

Defines the price and sku of a product whose page contains a customized set of checkbox values.

Fields

Field NameDescription
option_type_id - Int
The ID assigned to the value.
price - Float
The price assigned to this option.
price_type - PriceTypeEnum
FIXED, PERCENT, or DYNAMIC.
sku - String
The Stock Keeping Unit for this option.
sort_order - Int
The order in which the checkbox value is displayed.
title - String
The display name for this option.
uid - ID!
The unique ID for a `CustomizableCheckboxValue` object.

Example

Copied to your clipboard
{
  "option_type_id": 123,
  "price": 987.65,
  "price_type": "FIXED",
  "sku": "xyz789",
  "sort_order": 987,
  "title": "abc123",
  "uid": "4"
}

CustomizableDateOption

Contains information about a date picker that is defined as part of a customizable option.

Fields

Field NameDescription
option_id - Int
Option ID. (Deprecated: Use `uid` instead)
product_sku - String
The Stock Keeping Unit of the base product.
required - Boolean
Indicates whether the option is required.
sort_order - Int
The order in which the option is displayed.
title - String
The display name for this option.
uid - ID!
The unique ID for a `CustomizableOptionInterface` object.
value - CustomizableDateValue
An object that defines a date field in a customizable option.

Example

Copied to your clipboard
{
  "option_id": 987,
  "product_sku": "xyz789",
  "required": false,
  "sort_order": 987,
  "title": "abc123",
  "uid": 4,
  "value": CustomizableDateValue
}

CustomizableDateTypeEnum

Defines the customizable date type.

Values

Enum ValueDescription
DATE
DATE_TIME
TIME

Example

Copied to your clipboard
""DATE""

CustomizableDateValue

Defines the price and sku of a product whose page contains a customized date picker.

Fields

Field NameDescription
price - Float
The price assigned to this option.
price_type - PriceTypeEnum
FIXED, PERCENT, or DYNAMIC.
sku - String
The Stock Keeping Unit for this option.
type - CustomizableDateTypeEnum
DATE, DATE_TIME or TIME
uid - ID!
The unique ID for a `CustomizableDateValue` object.

Example

Copied to your clipboard
{
  "price": 123.45,
  "price_type": "FIXED",
  "sku": "abc123",
  "type": "DATE",
  "uid": "4"
}

CustomizableDropDownOption

Contains information about a drop down menu that is defined as part of a customizable option.

Fields

Field NameDescription
option_id - Int
Option ID. (Deprecated: Use `uid` instead)
required - Boolean
Indicates whether the option is required.
sort_order - Int
The order in which the option is displayed.
title - String
The display name for this option.
uid - ID!
The unique ID for a `CustomizableOptionInterface` object.
value - [CustomizableDropDownValue]
An array that defines the set of options for a drop down menu.

Example

Copied to your clipboard
{
  "option_id": 987,
  "required": true,
  "sort_order": 123,
  "title": "abc123",
  "uid": 4,
  "value": [CustomizableDropDownValue]
}

CustomizableDropDownValue

Defines the price and sku of a product whose page contains a customized drop down menu.

Fields

Field NameDescription
option_type_id - Int
The ID assigned to the value.
price - Float
The price assigned to this option.
price_type - PriceTypeEnum
FIXED, PERCENT, or DYNAMIC.
sku - String
The Stock Keeping Unit for this option.
sort_order - Int
The order in which the option is displayed.
title - String
The display name for this option.
uid - ID!
The unique ID for a `CustomizableDropDownValue` object.

Example

Copied to your clipboard
{
  "option_type_id": 987,
  "price": 987.65,
  "price_type": "FIXED",
  "sku": "xyz789",
  "sort_order": 123,
  "title": "xyz789",
  "uid": 4
}

CustomizableFieldOption

Contains information about a text field that is defined as part of a customizable option.

Fields

Field NameDescription
option_id - Int
Option ID. (Deprecated: Use `uid` instead)
product_sku - String
The Stock Keeping Unit of the base product.
required - Boolean
Indicates whether the option is required.
sort_order - Int
The order in which the option is displayed.
title - String
The display name for this option.
uid - ID!
The unique ID for a `CustomizableOptionInterface` object.
value - CustomizableFieldValue
An object that defines a text field.

Example

Copied to your clipboard
{
  "option_id": 123,
  "product_sku": "xyz789",
  "required": false,
  "sort_order": 123,
  "title": "abc123",
  "uid": "4",
  "value": CustomizableFieldValue
}

CustomizableFieldValue

Defines the price and sku of a product whose page contains a customized text field.

Fields

Field NameDescription
max_characters - Int
The maximum number of characters that can be entered for this customizable option.
price - Float
The price of the custom value.
price_type - PriceTypeEnum
FIXED, PERCENT, or DYNAMIC.
sku - String
The Stock Keeping Unit for this option.
uid - ID!
The unique ID for a `CustomizableFieldValue` object.

Example

Copied to your clipboard
{
  "max_characters": 987,
  "price": 987.65,
  "price_type": "FIXED",
  "sku": "xyz789",
  "uid": "4"
}

CustomizableFileOption

Contains information about a file picker that is defined as part of a customizable option.

Fields

Field NameDescription
option_id - Int
Option ID. (Deprecated: Use `uid` instead)
product_sku - String
The Stock Keeping Unit of the base product.
required - Boolean
Indicates whether the option is required.
sort_order - Int
The order in which the option is displayed.
title - String
The display name for this option.
uid - ID!
The unique ID for a `CustomizableOptionInterface` object.
value - CustomizableFileValue
An object that defines a file value.

Example

Copied to your clipboard
{
  "option_id": 123,
  "product_sku": "xyz789",
  "required": false,
  "sort_order": 987,
  "title": "xyz789",
  "uid": 4,
  "value": CustomizableFileValue
}

CustomizableFileValue

Defines the price and sku of a product whose page contains a customized file picker.

Fields

Field NameDescription
file_extension - String
The file extension to accept.
image_size_x - Int
The maximum width of an image.
image_size_y - Int
The maximum height of an image.
price - Float
The price assigned to this option.
price_type - PriceTypeEnum
FIXED, PERCENT, or DYNAMIC.
sku - String
The Stock Keeping Unit for this option.
uid - ID!
The unique ID for a `CustomizableFileValue` object.

Example

Copied to your clipboard
{
  "file_extension": "abc123",
  "image_size_x": 123,
  "image_size_y": 987,
  "price": 123.45,
  "price_type": "FIXED",
  "sku": "abc123",
  "uid": 4
}

CustomizableMultipleOption

Contains information about a multiselect that is defined as part of a customizable option.

Fields

Field NameDescription
option_id - Int
Option ID. (Deprecated: Use `uid` instead)
required - Boolean
Indicates whether the option is required.
sort_order - Int
The order in which the option is displayed.
title - String
The display name for this option.
uid - ID!
The unique ID for a `CustomizableOptionInterface` object.
value - [CustomizableMultipleValue]
An array that defines the set of options for a multiselect.

Example

Copied to your clipboard
{
  "option_id": 123,
  "required": false,
  "sort_order": 123,
  "title": "abc123",
  "uid": "4",
  "value": [CustomizableMultipleValue]
}

CustomizableMultipleValue

Defines the price and sku of a product whose page contains a customized multiselect.

Fields

Field NameDescription
option_type_id - Int
The ID assigned to the value.
price - Float
The price assigned to this option.
price_type - PriceTypeEnum
FIXED, PERCENT, or DYNAMIC.
sku - String
The Stock Keeping Unit for this option.
sort_order - Int
The order in which the option is displayed.
title - String
The display name for this option.
uid - ID!
The unique ID for a `CustomizableMultipleValue` object.

Example

Copied to your clipboard
{
  "option_type_id": 123,
  "price": 987.65,
  "price_type": "FIXED",
  "sku": "xyz789",
  "sort_order": 987,
  "title": "xyz789",
  "uid": "4"
}

CustomizableOptionInput

Defines a customizable option.

Input Fields

Input FieldDescription
id - Int
The customizable option ID of the product.
uid - ID
The unique ID for a `CartItemInterface` object.
value_string - String!
The string value of the option.

Example

Copied to your clipboard
{
  "id": 987,
  "uid": 4,
  "value_string": "abc123"
}

CustomizableOptionInterface

Contains basic information about a customizable option. It can be implemented by several types of configurable options.

Fields

Field NameDescription
option_id - Int
Option ID. (Deprecated: Use `uid` instead)
required - Boolean
Indicates whether the option is required.
sort_order - Int
The order in which the option is displayed.
title - String
The display name for this option.
uid - ID!
The unique ID for a `CustomizableOptionInterface` object.

Possible Types

CustomizableOptionInterface Types
CustomizableAreaOption
CustomizableDateOption
CustomizableDropDownOption
CustomizableMultipleOption
CustomizableFieldOption
CustomizableFileOption
CustomizableRadioOption
CustomizableCheckboxOption

Example

Copied to your clipboard
{
  "option_id": 123,
  "required": false,
  "sort_order": 123,
  "title": "abc123",
  "uid": "4"
}

CustomizableProductInterface

Contains information about customizable product options.

Fields

Field NameDescription
options - [CustomizableOptionInterface]
An array of options for a customizable product.

Possible Types

CustomizableProductInterface Types
VirtualProduct
SimpleProduct
ConfigurableProduct
DownloadableProduct
BundleProduct
GiftCardProduct

Example

Copied to your clipboard
{"options": [CustomizableOptionInterface]}

CustomizableRadioOption

Contains information about a set of radio buttons that are defined as part of a customizable option.

Fields

Field NameDescription
option_id - Int
Option ID. (Deprecated: Use `uid` instead)
required - Boolean
Indicates whether the option is required.
sort_order - Int
The order in which the option is displayed.
title - String
The display name for this option.
uid - ID!
The unique ID for a `CustomizableOptionInterface` object.
value - [CustomizableRadioValue]
An array that defines a set of radio buttons.

Example

Copied to your clipboard
{
  "option_id": 123,
  "required": false,
  "sort_order": 123,
  "title": "xyz789",
  "uid": 4,
  "value": [CustomizableRadioValue]
}

CustomizableRadioValue

Defines the price and sku of a product whose page contains a customized set of radio buttons.

Fields

Field NameDescription
option_type_id - Int
The ID assigned to the value.
price - Float
The price assigned to this option.
price_type - PriceTypeEnum
FIXED, PERCENT, or DYNAMIC.
sku - String
The Stock Keeping Unit for this option.
sort_order - Int
The order in which the radio button is displayed.
title - String
The display name for this option.
uid - ID!
The unique ID for a `CustomizableRadioValue` object.

Example

Copied to your clipboard
{
  "option_type_id": 987,
  "price": 987.65,
  "price_type": "FIXED",
  "sku": "xyz789",
  "sort_order": 987,
  "title": "abc123",
  "uid": 4
}

DeleteCompanyRoleOutput

Contains the response to the request to delete the company role.

Fields

Field NameDescription
success - Boolean!
SIndicates whether the company role has been deleted successfully.

Example

Copied to your clipboard
{"success": true}

DeleteCompanyTeamOutput

Contains the status of the request to delete a company team.

Fields

Field NameDescription
success - Boolean!
Indicates whether the delete operation succeeded.

Example

Copied to your clipboard
{"success": false}

DeleteCompanyUserOutput

Contains the response to the request to delete the company user.

Fields

Field NameDescription
success - Boolean!
Indicates whether the company user has been deactivated successfully.

Example

Copied to your clipboard
{"success": true}

DeleteCompareListOutput

Contains the results of the request to delete a compare list.

Fields

Field NameDescription
result - Boolean!
Indicates whether the compare list was successfully deleted.

Example

Copied to your clipboard
{"result": true}

DeleteNegotiableQuoteError

Types

Union Types
NegotiableQuoteInvalidStateError
NoSuchEntityUidError
InternalError

Example

Copied to your clipboard
NegotiableQuoteInvalidStateError

DeleteNegotiableQuoteOperationFailure

Contains details about a failed delete operation on a negotiable quote.

Fields

Field NameDescription
errors - [DeleteNegotiableQuoteError]!
quote_uid - ID!
The unique ID of a `NegotiableQuote` object.

Example

Copied to your clipboard
{
  "errors": [NegotiableQuoteInvalidStateError],
  "quote_uid": "4"
}

DeleteNegotiableQuoteOperationResult

Types

Union Types
NegotiableQuoteUidOperationSuccess
DeleteNegotiableQuoteOperationFailure

Example

Copied to your clipboard
NegotiableQuoteUidOperationSuccess

DeleteNegotiableQuoteTemplateInput

Specifies the quote template id of the quote template to delete

Input Fields

Input FieldDescription
template_id - ID!
The unique ID of a `NegotiableQuoteTemplate` object.

Example

Copied to your clipboard
{"template_id": "4"}

DeleteNegotiableQuotesInput

Input Fields

Input FieldDescription
quote_uids - [ID]!
A list of unique IDs for `NegotiableQuote` objects to delete.

Example

Copied to your clipboard
{"quote_uids": ["4"]}

DeleteNegotiableQuotesOutput

Contains a list of undeleted negotiable quotes the company user can view.

Fields

Field NameDescription
negotiable_quotes - NegotiableQuotesOutput
A list of negotiable quotes that the customer can view
operation_results - [DeleteNegotiableQuoteOperationResult]!
An array of deleted negotiable quote UIDs and details about any errors.
result_status - BatchMutationStatus!
The status of the request to delete one or more negotiable quotes.

Example

Copied to your clipboard
{
  "negotiable_quotes": NegotiableQuotesOutput,
  "operation_results": [
    NegotiableQuoteUidOperationSuccess
  ],
  "result_status": "SUCCESS"
}

DeletePaymentTokenOutput

Indicates whether the request succeeded and returns the remaining customer payment tokens.

Fields

Field NameDescription
customerPaymentTokens - CustomerPaymentTokens
A container for the customer's remaining payment tokens.
result - Boolean!
Indicates whether the request succeeded.

Example

Copied to your clipboard
{
  "customerPaymentTokens": CustomerPaymentTokens,
  "result": false
}

DeletePurchaseOrderApprovalRuleError

Contains details about an error that occurred when deleting an approval rule .

Fields

Field NameDescription
message - String
The text of the error message.
type - DeletePurchaseOrderApprovalRuleErrorType
The error type.

Example

Copied to your clipboard
{"message": "abc123", "type": "UNDEFINED"}

DeletePurchaseOrderApprovalRuleErrorType

Values

Enum ValueDescription
UNDEFINED
NOT_FOUND

Example

Copied to your clipboard
""UNDEFINED""

DeletePurchaseOrderApprovalRuleInput

Specifies the IDs of the approval rules to delete.

Input Fields

Input FieldDescription
approval_rule_uids - [ID]!
An array of purchase order approval rule IDs.

Example

Copied to your clipboard
{"approval_rule_uids": ["4"]}

DeletePurchaseOrderApprovalRuleOutput

Contains any errors encountered while attempting to delete approval rules.

Fields

Field NameDescription
errors - [DeletePurchaseOrderApprovalRuleError]!
An array of error messages encountered while performing the operation.

Example

Copied to your clipboard
{"errors": [DeletePurchaseOrderApprovalRuleError]}

DeleteRequisitionListItemsOutput

Output of the request to remove items from the requisition list.

Fields

Field NameDescription
requisition_list - RequisitionList
The requisition list after removing items.

Example

Copied to your clipboard
{"requisition_list": RequisitionList}

DeleteRequisitionListOutput

Indicates whether the request to delete the requisition list was successful.

Fields

Field NameDescription
requisition_lists - RequisitionLists
The customer's requisition lists after deleting a requisition list.
status - Boolean!
Indicates whether the request to delete the requisition list was successful.

Example

Copied to your clipboard
{"requisition_lists": RequisitionLists, "status": false}

DeleteWishlistOutput

Contains the status of the request to delete a wish list and an array of the customer's remaining wish lists.

Fields

Field NameDescription
status - Boolean!
Indicates whether the wish list was deleted.
wishlists - [Wishlist]!
A list of undeleted wish lists.

Example

Copied to your clipboard
{"status": false, "wishlists": [Wishlist]}

Discount

Specifies the discount type and value for quote line item.

Fields

Field NameDescription
amount - Money!
The amount of the discount.
applied_to - CartDiscountType!
The type of the entity the discount is applied to.
coupon - AppliedCoupon
The coupon related to the discount.
is_discounting_locked - Boolean
Is quote discounting locked for line item.
label - String!
A description of the discount.
type - String
Quote line item discount type. Values: 1 = PERCENTAGE_DISCOUNT; 2 = AMOUNT_DISCOUNT; 3 = PROPOSED_TOTAL.
value - Float
Quote line item discount value.

Example

Copied to your clipboard
{
  "amount": Money,
  "applied_to": "ITEM",
  "coupon": AppliedCoupon,
  "is_discounting_locked": false,
  "label": "xyz789",
  "type": "xyz789",
  "value": 123.45
}

DownloadableCartItem

An implementation for downloadable product cart items.

Fields

Field NameDescription
customizable_options - [SelectedCustomizableOption]!
An array containing the customizable options the shopper selected.
discount - [Discount]
Contains discount for quote line item.
errors - [CartItemError]
An array of errors encountered while loading the cart item
id - String!
(Deprecated: Use `uid` instead.)
is_available - Boolean!
True if requested quantity is less than available stock, false otherwise.
links - [DownloadableProductLinks]
An array containing information about the links for the downloadable product added to the cart.
max_qty - Float
Line item max qty in quote template
min_qty - Float
Line item min qty in quote template
not_available_message - String
Message to display when the product is not available with this selected option.
note_from_buyer - [ItemNote]
The buyer's quote line item note.
note_from_seller - [ItemNote]
The seller's quote line item note.
prices - CartItemPrices
Contains details about the price of the item, including taxes and discounts.
product - ProductInterface!
Details about an item in the cart.
quantity - Float!
The quantity of this item in the cart.
samples - [DownloadableProductSamples]
An array containing information about samples of the selected downloadable product.
uid - ID!
The unique ID for a `CartItemInterface` object.

Example

Copied to your clipboard
{
  "customizable_options": [SelectedCustomizableOption],
  "discount": [Discount],
  "errors": [CartItemError],
  "id": "xyz789",
  "is_available": true,
  "links": [DownloadableProductLinks],
  "max_qty": 123.45,
  "min_qty": 123.45,
  "not_available_message": "xyz789",
  "note_from_buyer": [ItemNote],
  "note_from_seller": [ItemNote],
  "prices": CartItemPrices,
  "product": ProductInterface,
  "quantity": 123.45,
  "samples": [DownloadableProductSamples],
  "uid": "4"
}

DownloadableCreditMemoItem

Defines downloadable product options for CreditMemoItemInterface.

Fields

Field NameDescription
discounts - [Discount]
Details about the final discount amount for the base product, including discounts on options.
downloadable_links - [DownloadableItemsLinks]
A list of downloadable links that are refunded from the downloadable product.
id - ID!
The unique ID for a `CreditMemoItemInterface` object.
order_item - OrderItemInterface
The order item the credit memo is applied to.
product_name - String
The name of the base product.
product_sale_price - Money!
The sale price for the base product, including selected options.
product_sku - String!
The SKU of the base product.
quantity_refunded - Float
The number of refunded items.

Example

Copied to your clipboard
{
  "discounts": [Discount],
  "downloadable_links": [DownloadableItemsLinks],
  "id": "4",
  "order_item": OrderItemInterface,
  "product_name": "xyz789",
  "product_sale_price": Money,
  "product_sku": "abc123",
  "quantity_refunded": 987.65
}

DownloadableFileTypeEnum

Values

Enum ValueDescription
FILE
(Deprecated: `sample_url` serves to get the downloadable sample)
URL
(Deprecated: `sample_url` serves to get the downloadable sample)

Example

Copied to your clipboard
""FILE""

DownloadableInvoiceItem

Defines downloadable product options for InvoiceItemInterface.

Fields

Field NameDescription
discounts - [Discount]
Information about the final discount amount for the base product, including discounts on options.
downloadable_links - [DownloadableItemsLinks]
A list of downloadable links that are invoiced from the downloadable product.
id - ID!
The unique ID for an `InvoiceItemInterface` object.
order_item - OrderItemInterface
Details about an individual order item.
product_name - String
The name of the base product.
product_sale_price - Money!
The sale price for the base product including selected options.
product_sku - String!
The SKU of the base product.
quantity_invoiced - Float
The number of invoiced items.

Example

Copied to your clipboard
{
  "discounts": [Discount],
  "downloadable_links": [DownloadableItemsLinks],
  "id": 4,
  "order_item": OrderItemInterface,
  "product_name": "xyz789",
  "product_sale_price": Money,
  "product_sku": "abc123",
  "quantity_invoiced": 987.65
}

DownloadableItemsLinks

Defines characteristics of the links for downloadable product.

Fields

Field NameDescription
sort_order - Int
A number indicating the sort order.
title - String
The display name of the link.
uid - ID!
The unique ID for a `DownloadableItemsLinks` object.

Example

Copied to your clipboard
{
  "sort_order": 123,
  "title": "abc123",
  "uid": 4
}

DownloadableOrderItem

Defines downloadable product options for OrderItemInterface.

Fields

Field NameDescription
discounts - [Discount]
The final discount information for the product.
downloadable_links - [DownloadableItemsLinks]
A list of downloadable links that are ordered from the downloadable product.
eligible_for_return - Boolean
Indicates whether the order item is eligible to be in a return request.
entered_options - [OrderItemOption]
The entered option for the base product, such as a logo or image.
gift_message - GiftMessage
The selected gift message for the order item
gift_wrapping - GiftWrapping
The selected gift wrapping for the order item.
id - ID!
The unique ID for an `OrderItemInterface` object.
prices - OrderItemPrices
Contains details about the price of the item, including taxes and discounts.
product - ProductInterface
The ProductInterface object, which contains details about the base product
product_name - String
The name of the base product.
product_sale_price - Money!
The sale price of the base product, including selected options.
product_sku - String!
The SKU of the base product.
product_type - String
The type of product, such as simple, configurable, etc.
product_url_key - String
URL key of the base product.
quantity_canceled - Float
The number of canceled items.
quantity_invoiced - Float
The number of invoiced items.
quantity_ordered - Float
The number of units ordered for this item.
quantity_refunded - Float
The number of refunded items.
quantity_return_requested - Float
The requested return quantity of the item.
quantity_returned - Float
The number of returned items.
quantity_shipped - Float
The number of shipped items.
selected_options - [OrderItemOption]
The selected options for the base product, such as color or size.
status - String
The status of the order item.

Example

Copied to your clipboard
{
  "discounts": [Discount],
  "downloadable_links": [DownloadableItemsLinks],
  "eligible_for_return": false,
  "entered_options": [OrderItemOption],
  "gift_message": GiftMessage,
  "gift_wrapping": GiftWrapping,
  "id": 4,
  "prices": OrderItemPrices,
  "product": ProductInterface,
  "product_name": "xyz789",
  "product_sale_price": Money,
  "product_sku": "xyz789",
  "product_type": "abc123",
  "product_url_key": "xyz789",
  "quantity_canceled": 123.45,
  "quantity_invoiced": 123.45,
  "quantity_ordered": 123.45,
  "quantity_refunded": 123.45,
  "quantity_return_requested": 987.65,
  "quantity_returned": 123.45,
  "quantity_shipped": 123.45,
  "selected_options": [OrderItemOption],
  "status": "abc123"
}

DownloadableProduct

Defines a product that the shopper downloads.

Fields

Field NameDescription
attribute_set_id - Int
The attribute set assigned to the product. (Deprecated: The field should not be used on the storefront.)
canonical_url - String
The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.
categories - [CategoryInterface]
The categories assigned to a product.
color - Int
(Deprecated: Use the `custom_attributes` field instead.)
country_of_manufacture - String
The product's country of origin.
created_at - String
Timestamp indicating when the product was created. (Deprecated: The field should not be used on the storefront.)
crosssell_products - [ProductInterface]
An array of cross-sell products.
custom_attributesV2 - ProductCustomAttributes
Product custom attributes.
description - ComplexTextValue
Detailed information about the product. The value can include simple HTML tags.
downloadable_product_links - [DownloadableProductLinks]
An array containing information about the links for this downloadable product.
downloadable_product_samples - [DownloadableProductSamples]
An array containing information about samples of this downloadable product.
gift_message_available - Boolean!
Returns a value indicating gift message availability for the product.
gift_wrapping_available - Boolean!
Returns a value indicating gift wrapping availability for the product.
gift_wrapping_price - Money
Returns value and currency indicating gift wrapping price for the product.
id - Int
The ID number assigned to the product. (Deprecated: Use the `uid` field instead.)
image - ProductImage
The relative path to the main image on the product page.
is_returnable - String
Indicates whether the product can be returned.
links_purchased_separately - Int
A value of 1 indicates that each link in the array must be purchased separately.
links_title - String
The heading above the list of downloadable products.
manufacturer - Int
A number representing the product's manufacturer. (Deprecated: Use the `custom_attributes` field instead.)
max_sale_qty - Float
Maximum Qty Allowed in Shopping Cart
media_gallery - [MediaGalleryInterface]
An array of media gallery objects.
media_gallery_entries - [MediaGalleryEntry]
An array of MediaGalleryEntry objects. (Deprecated: Use `media_gallery` instead.)
meta_description - String
A brief overview of the product for search results listings, maximum 255 characters.
meta_keyword - String
A comma-separated list of keywords that are visible only to search engines.
meta_title - String
A string that is displayed in the title bar and tab of the browser and in search results lists.
min_sale_qty - Float
Minimum Qty Allowed in Shopping Cart
name - String
The product name. Customers use this name to identify the product.
new_from_date - String
The beginning date for new product listings, and determines if the product is featured as a new product.
new_to_date - String
The end date for new product listings.
only_x_left_in_stock - Float
Product stock only x left count
options - [CustomizableOptionInterface]
An array of options for a customizable product.
options_container - String
If the product has multiple options, determines where they appear on the product page.
price - ProductPrices
Indicates the price of an item. (Deprecated: Use `price_range` for product price information.)
price_range - PriceRange!
The range of prices for the product
price_tiers - [TierPrice]
An array of `TierPrice` objects.
product_links - [ProductLinksInterface]
An array of `ProductLinks` objects.
quantity - Float
Amount of available stock
rating_summary - Float!
The average of all the ratings given to the product.
redirect_code - Int!
Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.
related_products - [ProductInterface]
An array of related products.
relative_url - String
The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.
review_count - Int!
The total count of all the reviews given to the product.
reviews - ProductReviews!
The list of products reviews.
short_description - ComplexTextValue
A short description of the product. Its use depends on the theme.
sku - String
A number or code assigned to a product to identify the product, options, price, and manufacturer.
small_image - ProductImage
The relative path to the small image, which is used on catalog pages.
special_from_date - String
The beginning date that a product has a special price. (Deprecated: The field should not be used on the storefront.)
special_price - Float
The discounted price of the product.
special_to_date - String
The end date for a product with a special price.
staged - Boolean!
Indicates whether the product is staged for a future campaign.
stock_status - ProductStockStatus
Stock status of the product
swatch_image - String
The file name of a swatch image.
thumbnail - ProductImage
The relative path to the product's thumbnail image.
tier_price - Float
The price when tier pricing is in effect and the items purchased threshold has been reached. (Deprecated: Use `price_tiers` for product tier price information.)
tier_prices - [ProductTierPrices]
An array of ProductTierPrices objects. (Deprecated: Use `price_tiers` for product tier price information.)
type - UrlRewriteEntityTypeEnum
One of PRODUCT, CATEGORY, or CMS_PAGE.
type_id - String
One of simple, virtual, bundle, downloadable, grouped, or configurable. (Deprecated: Use `__typename` instead.)
uid - ID!
The unique ID for a `ProductInterface` object.
updated_at - String
Timestamp indicating when the product was updated. (Deprecated: The field should not be used on the storefront.)
upsell_products - [ProductInterface]
An array of up-sell products.
url_key - String
The part of the URL that identifies the product
url_path - String
(Deprecated: Use product's `canonical_url` or url rewrites instead)
url_rewrites - [UrlRewrite]
URL rewrites list
url_suffix - String
The part of the product URL that is appended after the url key
websites - [Website]
An array of websites in which the product is available. (Deprecated: The field should not be used on the storefront.)

Example

Copied to your clipboard
{
  "attribute_set_id": 123,
  "canonical_url": "xyz789",
  "categories": [CategoryInterface],
  "color": 123,
  "country_of_manufacture": "xyz789",
  "created_at": "abc123",
  "crosssell_products": [ProductInterface],
  "custom_attributesV2": ProductCustomAttributes,
  "description": ComplexTextValue,
  "downloadable_product_links": [
    DownloadableProductLinks
  ],
  "downloadable_product_samples": [
    DownloadableProductSamples
  ],
  "gift_message_available": true,
  "gift_wrapping_available": true,
  "gift_wrapping_price": Money,
  "id": 987,
  "image": ProductImage,
  "is_returnable": "xyz789",
  "links_purchased_separately": 987,
  "links_title": "xyz789",
  "manufacturer": 123,
  "max_sale_qty": 123.45,
  "media_gallery": [MediaGalleryInterface],
  "media_gallery_entries": [MediaGalleryEntry],
  "meta_description": "xyz789",
  "meta_keyword": "xyz789",
  "meta_title": "abc123",
  "min_sale_qty": 123.45,
  "name": "xyz789",
  "new_from_date": "xyz789",
  "new_to_date": "abc123",
  "only_x_left_in_stock": 123.45,
  "options": [CustomizableOptionInterface],
  "options_container": "abc123",
  "price": ProductPrices,
  "price_range": PriceRange,
  "price_tiers": [TierPrice],
  "product_links": [ProductLinksInterface],
  "quantity": 123.45,
  "rating_summary": 987.65,
  "redirect_code": 123,
  "related_products": [ProductInterface],
  "relative_url": "xyz789",
  "review_count": 987,
  "reviews": ProductReviews,
  "short_description": ComplexTextValue,
  "sku": "abc123",
  "small_image": ProductImage,
  "special_from_date": "xyz789",
  "special_price": 123.45,
  "special_to_date": "xyz789",
  "staged": true,
  "stock_status": "IN_STOCK",
  "swatch_image": "xyz789",
  "thumbnail": ProductImage,
  "tier_price": 987.65,
  "tier_prices": [ProductTierPrices],
  "type": "CMS_PAGE",
  "type_id": "abc123",
  "uid": "4",
  "updated_at": "xyz789",
  "upsell_products": [ProductInterface],
  "url_key": "abc123",
  "url_path": "xyz789",
  "url_rewrites": [UrlRewrite],
  "url_suffix": "xyz789",
  "websites": [Website]
}

DownloadableProductCartItemInput

Defines a single downloadable product.

Input Fields

Input FieldDescription
customizable_options - [CustomizableOptionInput]
The ID and value of the option.
data - CartItemInput!
The quantity and SKU of the downloadable product.
downloadable_product_links - [DownloadableProductLinksInput]
An array of objects containing the link_id of the downloadable product link.

Example

Copied to your clipboard
{
  "customizable_options": [CustomizableOptionInput],
  "data": CartItemInput,
  "downloadable_product_links": [
    DownloadableProductLinksInput
  ]
}

DownloadableProductLinks

Defines characteristics of a downloadable product.

Fields

Field NameDescription
id - Int
(Deprecated: This information should not be exposed on frontend.)
is_shareable - Boolean
(Deprecated: This information should not be exposed on frontend.)
link_type - DownloadableFileTypeEnum
(Deprecated: `sample_url` serves to get the downloadable sample)
number_of_downloads - Int
(Deprecated: This information should not be exposed on frontend.)
price - Float
The price of the downloadable product.
sample_file - String
(Deprecated: `sample_url` serves to get the downloadable sample)
sample_type - DownloadableFileTypeEnum
(Deprecated: `sample_url` serves to get the downloadable sample)
sample_url - String
The full URL to the downloadable sample.
sort_order - Int
A number indicating the sort order.
title - String
The display name of the link.
uid - ID!
The unique ID for a `DownloadableProductLinks` object.

Example

Copied to your clipboard
{
  "id": 987,
  "is_shareable": false,
  "link_type": "FILE",
  "number_of_downloads": 987,
  "price": 123.45,
  "sample_file": "xyz789",
  "sample_type": "FILE",
  "sample_url": "xyz789",
  "sort_order": 123,
  "title": "xyz789",
  "uid": "4"
}

DownloadableProductLinksInput

Contains the link ID for the downloadable product.

Input Fields

Input FieldDescription
link_id - Int!
The unique ID of the downloadable product link.

Example

Copied to your clipboard
{"link_id": 987}

DownloadableProductSamples

Defines characteristics of a downloadable product.

Fields

Field NameDescription
id - Int
(Deprecated: This information should not be exposed on frontend.)
sample_file - String
(Deprecated: `sample_url` serves to get the downloadable sample)
sample_type - DownloadableFileTypeEnum
(Deprecated: `sample_url` serves to get the downloadable sample)
sample_url - String
The full URL to the downloadable sample.
sort_order - Int
A number indicating the sort order.
title - String
The display name of the sample.

Example

Copied to your clipboard
{
  "id": 987,
  "sample_file": "xyz789",
  "sample_type": "FILE",
  "sample_url": "xyz789",
  "sort_order": 123,
  "title": "xyz789"
}

DownloadableRequisitionListItem

Contains details about downloadable products added to a requisition list.

Fields

Field NameDescription
customizable_options - [SelectedCustomizableOption]!
Selected custom options for an item in the requisition list.
links - [DownloadableProductLinks]
An array of links for downloadable products in the requisition list.
product - ProductInterface!
Details about a requisition list item.
quantity - Float!
The quantity of the product added to the requisition list.
samples - [DownloadableProductSamples]
An array of links to downloadable product samples.
uid - ID!
The unique ID of an item in a requisition list.

Example

Copied to your clipboard
{
  "customizable_options": [SelectedCustomizableOption],
  "links": [DownloadableProductLinks],
  "product": ProductInterface,
  "quantity": 123.45,
  "samples": [DownloadableProductSamples],
  "uid": "4"
}

DownloadableWishlistItem

A downloadable product wish list item.

Fields

Field NameDescription
added_at - String!
The date and time the item was added to the wish list.
customizable_options - [SelectedCustomizableOption]!
Custom options selected for the wish list item.
description - String
The description of the item.
id - ID!
The unique ID for a `WishlistItemInterface` object.
links_v2 - [DownloadableProductLinks]
An array containing information about the selected links.
product - ProductInterface
Product details of the wish list item.
quantity - Float!
The quantity of this wish list item.
samples - [DownloadableProductSamples]
An array containing information about the selected samples.

Example

Copied to your clipboard
{
  "added_at": "xyz789",
  "customizable_options": [SelectedCustomizableOption],
  "description": "abc123",
  "id": "4",
  "links_v2": [DownloadableProductLinks],
  "product": ProductInterface,
  "quantity": 987.65,
  "samples": [DownloadableProductSamples]
}

DuplicateNegotiableQuoteInput

Identifies a quote to be duplicated

Input Fields

Input FieldDescription
duplicated_quote_uid - ID!
ID for the newly duplicated quote.
quote_uid - ID!
ID of the quote to be duplicated.

Example

Copied to your clipboard
{
  "duplicated_quote_uid": "4",
  "quote_uid": "4"
}

DuplicateNegotiableQuoteOutput

Contains the newly created negotiable quote.

Fields

Field NameDescription
quote - NegotiableQuote
Negotiable Quote resulting from duplication operation.

Example

Copied to your clipboard
{"quote": NegotiableQuote}

DynamicBlock

Contains a single dynamic block.

Fields

Field NameDescription
content - ComplexTextValue!
The renderable HTML code of the dynamic block.
uid - ID!
The unique ID of a `DynamicBlock` object.

Example

Copied to your clipboard
{
  "content": ComplexTextValue,
  "uid": "4"
}

DynamicBlockLocationEnum

Indicates the locations the dynamic block can be placed. If this field is not specified, the query returns all locations.

Values

Enum ValueDescription
CONTENT
HEADER
FOOTER
LEFT
RIGHT

Example

Copied to your clipboard
""CONTENT""

DynamicBlockTypeEnum

Indicates the selected Dynamic Blocks Rotator inline widget.

Values

Enum ValueDescription
SPECIFIED
CART_PRICE_RULE_RELATED
CATALOG_PRICE_RULE_RELATED

Example

Copied to your clipboard
""SPECIFIED""

DynamicBlocks

Contains an array of dynamic blocks.

Fields

Field NameDescription
items - [DynamicBlock]!
An array containing individual dynamic blocks.
page_info - SearchResultPageInfo
Metadata for pagination rendering.
total_count - Int!
The number of returned dynamic blocks.

Example

Copied to your clipboard
{
  "items": [DynamicBlock],
  "page_info": SearchResultPageInfo,
  "total_count": 123
}

DynamicBlocksFilterInput

Defines the dynamic block filter. The filter can identify the block type, location and IDs to return.

Input Fields

Input FieldDescription
dynamic_block_uids - [ID]
An array of dynamic block UIDs to filter on.
locations - [DynamicBlockLocationEnum]
An array indicating the locations the dynamic block can be placed.
type - DynamicBlockTypeEnum!
A value indicating the type of dynamic block to filter on.

Example

Copied to your clipboard
{
  "dynamic_block_uids": ["4"],
  "locations": ["CONTENT"],
  "type": "SPECIFIED"
}

EnteredCustomAttributeInput

Contains details about a custom text attribute that the buyer entered.

Input Fields

Input FieldDescription
attribute_code - String!
A string that identifies the entered custom attribute.
value - String!
The text or other entered value.

Example

Copied to your clipboard
{
  "attribute_code": "abc123",
  "value": "xyz789"
}

EnteredOptionInput

Defines a customer-entered option.

Input Fields

Input FieldDescription
uid - ID!
The unique ID for a `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object.
value - String!
Text the customer entered.

Example

Copied to your clipboard
{
  "uid": "4",
  "value": "abc123"
}

EntityUrl

Contains the uid, relative_url, and type attributes.

Fields

Field NameDescription
canonical_url - String
(Deprecated: Use `relative_url` instead.)
entity_uid - ID
The unique ID for a `ProductInterface`, `CategoryInterface`, `CmsPage`, or similar object associated with the specified URL. This could be a product, category, or CMS page UID.
id - Int
The ID assigned to the object associated with the specified url. This could be a product ID, category ID, or page ID. (Deprecated: Use `entity_uid` instead.)
redirectCode - Int
Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.
relative_url - String
The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.
type - UrlRewriteEntityTypeEnum
One of PRODUCT, CATEGORY, or CMS_PAGE.

Example

Copied to your clipboard
{
  "canonical_url": "abc123",
  "entity_uid": "4",
  "id": 123,
  "redirectCode": 987,
  "relative_url": "xyz789",
  "type": "CMS_PAGE"
}

Error

An error encountered while adding an item to the the cart.

Fields

Field NameDescription
code - CartUserInputErrorType!
A cart-specific error code.
message - String!
A localized error message.

Possible Types

Error Types
CartUserInputError
InsufficientStockError

Example

Copied to your clipboard
{
  "code": "PRODUCT_NOT_FOUND",
  "message": "xyz789"
}

ErrorInterface

Fields

Field NameDescription
message - String!
The returned error message.

Possible Types

ErrorInterface Types
NoSuchEntityUidError
InternalError
NegotiableQuoteInvalidStateError

Example

Copied to your clipboard
{"message": "xyz789"}

EstimateAddressInput

Contains details about an address.

Input Fields

Input FieldDescription
country_code - CountryCodeEnum!
The two-letter code representing the customer's country.
postcode - String
The customer's ZIP or postal code.
region - CustomerAddressRegionInput
An object containing the region name, region code, and region ID.

Example

Copied to your clipboard
{
  "country_code": "AF",
  "postcode": "xyz789",
  "region": CustomerAddressRegionInput
}

EstimateTotalsInput

Input Fields

Input FieldDescription
address - EstimateAddressInput!
Customer's address to estimate totals.
cart_id - String!
The unique ID of the cart to query.
shipping_method - ShippingMethodInput
Selected shipping method to estimate totals.

Example

Copied to your clipboard
{
  "address": EstimateAddressInput,
  "cart_id": "abc123",
  "shipping_method": ShippingMethodInput
}

EstimateTotalsOutput

Estimate totals output.

Fields

Field NameDescription
cart - Cart
Cart after totals estimation

Example

Copied to your clipboard
{"cart": Cart}

ExchangeExternalCustomerTokenInput

Contains details about external customer.

Input Fields

Input FieldDescription
customer - CustomerCreateInput!
An input object that defines the customer characteristics to update.

Example

Copied to your clipboard
{"customer": CustomerCreateInput}

ExchangeExternalCustomerTokenOutput

Contains customer token for external customer.

Fields

Field NameDescription
customer - Customer!
Return detailed information about a customer account.
token - String!
The customer authorization token.

Example

Copied to your clipboard
{
  "customer": Customer,
  "token": "xyz789"
}

ExchangeRate

Lists the exchange rate.

Fields

Field NameDescription
currency_to - String
Specifies the store’s default currency to exchange to.
rate - Float
The exchange rate for the store’s default currency.

Example

Copied to your clipboard
{"currency_to": "abc123", "rate": 987.65}

FastlaneConfig

Fields

Field NameDescription
code - String
The payment method code as defined in the payment gateway
is_visible - Boolean
Indicates whether the payment method is displayed
payment_intent - String
Defines the payment intent (Authorize or Capture
payment_source - String
The payment source for the payment method
sdk_params - [SDKParams]
The PayPal parameters required to load the JS SDK
sort_order - String
The relative order the payment method is displayed on the checkout page
three_ds_mode - ThreeDSMode
3DS mode
title - String
The name displayed for the payment method

Example

Copied to your clipboard
{
  "code": "abc123",
  "is_visible": true,
  "payment_intent": "xyz789",
  "payment_source": "xyz789",
  "sdk_params": [SDKParams],
  "sort_order": "xyz789",
  "three_ds_mode": "OFF",
  "title": "abc123"
}

FastlaneMethodInput

Fastlane Payment inputs

Input Fields

Input FieldDescription
payment_source - String
The payment source for the payment method
paypal_fastlane_token - String
The single use token from Fastlane

Example

Copied to your clipboard
{
  "payment_source": "xyz789",
  "paypal_fastlane_token": "xyz789"
}

FilterEqualTypeInput

Defines a filter that matches the input exactly.

Input Fields

Input FieldDescription
eq - String
Use this attribute to exactly match the specified string. For example, to filter on a specific category ID, specify a value such as `5`.
in - [String]
Use this attribute to filter on an array of values. For example, to filter on category IDs 4, 5, and 6, specify a value of `["4", "5", "6"]`.

Example

Copied to your clipboard
{
  "eq": "xyz789",
  "in": ["abc123"]
}

FilterMatchTypeEnum

Values

Enum ValueDescription
FULL
PARTIAL

Example

Copied to your clipboard
""FULL""

FilterMatchTypeInput

Defines a filter that performs a fuzzy search.

Input Fields

Input FieldDescription
match - String
Use this attribute to fuzzy match the specified string. For example, to filter on a specific SKU, specify a value such as `24-MB01`.
match_type - FilterMatchTypeEnum
Filter match type for fine-tuned results. Possible values FULL or PARTIAL. If match_type is not provided, returned results will default to FULL match.

Example

Copied to your clipboard
{"match": "abc123", "match_type": "FULL"}

FilterRangeTypeInput

Defines a filter that matches a range of values, such as prices or dates.

Input Fields

Input FieldDescription
from - String
Use this attribute to specify the lowest possible value in the range.
to - String
Use this attribute to specify the highest possible value in the range.

Example

Copied to your clipboard
{
  "from": "abc123",
  "to": "abc123"
}

FilterStringTypeInput

Defines a filter for an input string.

Input Fields

Input FieldDescription
eq - String
Filters items that are exactly the same as the specified string.
in - [String]
Filters items that are exactly the same as entries specified in an array of strings.
match - String
Defines a filter that performs a fuzzy search using the specified string.

Example

Copied to your clipboard
{
  "eq": "abc123",
  "in": ["abc123"],
  "match": "xyz789"
}

FilterTypeInput

Defines the comparison operators that can be used in a filter.

Input Fields

Input FieldDescription
eq - String
Equals.
finset - [String]
from - String
From. Must be used with the `to` field.
gt - String
Greater than.
gteq - String
Greater than or equal to.
in - [String]
In. The value can contain a set of comma-separated values.
like - String
Like. The specified value can contain % (percent signs) to allow matching of 0 or more characters.
lt - String
Less than.
lteq - String
Less than or equal to.
moreq - String
More than or equal to.
neq - String
Not equal to.
nin - [String]
Not in. The value can contain a set of comma-separated values.
notnull - String
Not null.
null - String
Is null.
to - String
To. Must be used with the `from` field.

Example

Copied to your clipboard
{
  "eq": "xyz789",
  "finset": ["xyz789"],
  "from": "xyz789",
  "gt": "xyz789",
  "gteq": "abc123",
  "in": ["abc123"],
  "like": "abc123",
  "lt": "abc123",
  "lteq": "abc123",
  "moreq": "abc123",
  "neq": "xyz789",
  "nin": ["abc123"],
  "notnull": "abc123",
  "null": "xyz789",
  "to": "xyz789"
}

FixedProductTax

A single FPT that can be applied to a product price.

Fields

Field NameDescription
amount - Money
The amount of the Fixed Product Tax.
label - String
The display label assigned to the Fixed Product Tax.

Example

Copied to your clipboard
{
  "amount": Money,
  "label": "abc123"
}

FixedProductTaxDisplaySettings

Lists display settings for the Fixed Product Tax.

Values

Enum ValueDescription
INCLUDE_FPT_WITHOUT_DETAILS
The displayed price includes the FPT amount without displaying the `ProductPrice.fixed_product_taxes` values. This value corresponds to 'Including FPT only'.
INCLUDE_FPT_WITH_DETAILS
The displayed price includes the FPT amount while displaying the values of `ProductPrice.fixed_product_taxes` separately. This value corresponds to 'Including FPT and FPT description'.
EXCLUDE_FPT_AND_INCLUDE_WITH_DETAILS
The displayed price does not include the FPT amount. The values of `ProductPrice.fixed_product_taxes` and the price including the FPT are displayed separately. This value corresponds to 'Excluding FPT, Including FPT description and final price.'
EXCLUDE_FPT_WITHOUT_DETAILS
The displayed price does not include the FPT amount. The values from `ProductPrice.fixed_product_taxes` are not displayed. This value corresponds to 'Excluding FPT'.
FPT_DISABLED
The FPT feature is not enabled. You can omit `ProductPrice.fixed_product_taxes` from your query.

Example

Copied to your clipboard
""INCLUDE_FPT_WITHOUT_DETAILS""

Float

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example

Copied to your clipboard
123.45

GenerateCustomerTokenAsAdminInput

Identifies which customer requires remote shopping assistance.

Input Fields

Input FieldDescription
customer_email - String!
The email address of the customer requesting remote shopping assistance.

Example

Copied to your clipboard
{"customer_email": "abc123"}

GenerateCustomerTokenAsAdminOutput

Contains the generated customer token.

Fields

Field NameDescription
customer_token - String!
The generated customer token.

Example

Copied to your clipboard
{"customer_token": "abc123"}

GenerateNegotiableQuoteFromTemplateInput

Specifies the template id, from which to generate quote from.

Input Fields

Input FieldDescription
template_id - ID!
The unique ID of a `NegotiableQuoteTemplate` object.

Example

Copied to your clipboard
{"template_id": "4"}

GenerateNegotiableQuoteFromTemplateOutput

Contains the generated negotiable quote id.

Fields

Field NameDescription
negotiable_quote_uid - ID!
The unique ID of a generated `NegotiableQuote` object.

Example

Copied to your clipboard
{"negotiable_quote_uid": 4}

GetPaymentSDKOutput

Gets the payment SDK URLs and values

Fields

Field NameDescription
sdkParams - [PaymentSDKParamsItem]
The payment SDK parameters

Example

Copied to your clipboard
{"sdkParams": [PaymentSDKParamsItem]}

GiftCardAccount

Contains details about the gift card account.

Fields

Field NameDescription
balance - Money
The balance remaining on the gift card.
code - String
The gift card account code.
expiration_date - String
The expiration date of the gift card.

Example

Copied to your clipboard
{
  "balance": Money,
  "code": "abc123",
  "expiration_date": "abc123"
}

GiftCardAccountInput

Contains the gift card code.

Input Fields

Input FieldDescription
gift_card_code - String!
The applied gift card code.

Example

Copied to your clipboard
{"gift_card_code": "xyz789"}

GiftCardAmounts

Contains the value of a gift card, the website that generated the card, and related information.

Fields

Field NameDescription
attribute_id - Int
An internal attribute ID.
uid - ID!
The unique ID for a `GiftCardAmounts` object.
value - Float
The value of the gift card.
value_id - Int
An ID that is assigned to each unique gift card amount. (Deprecated: Use `uid` instead)
website_id - Int
The ID of the website that generated the gift card.
website_value - Float
The value of the gift card.

Example

Copied to your clipboard
{
  "attribute_id": 123,
  "uid": "4",
  "value": 987.65,
  "value_id": 987,
  "website_id": 123,
  "website_value": 123.45
}

GiftCardCartItem

Contains details about a gift card that has been added to a cart.

Fields

Field NameDescription
amount - Money!
The amount and currency of the gift card.
available_gift_wrapping - [GiftWrapping]!
The list of available gift wrapping options for the cart item.
customizable_options - [SelectedCustomizableOption]!
An array of customizations applied to the gift card.
discount - [Discount]
Contains discount for quote line item.
errors - [CartItemError]
An array of errors encountered while loading the cart item
gift_message - GiftMessage
The entered gift message data for the gift card cart item
gift_wrapping - GiftWrapping
The selected gift wrapping option for the cart item.
id - String!
(Deprecated: Use `uid` instead.)
is_available - Boolean!
True if requested quantity is less than available stock, false otherwise.
max_qty - Float
Line item max qty in quote template
message - String
The message from the sender to the recipient.
min_qty - Float
Line item min qty in quote template
not_available_message - String
Message to display when the product is not available with this selected option.
note_from_buyer - [ItemNote]
The buyer's quote line item note.
note_from_seller - [ItemNote]
The seller's quote line item note.
prices - CartItemPrices
Contains details about the price of the item, including taxes and discounts.
product - ProductInterface!
Details about an item in the cart.
quantity - Float!
The quantity of this item in the cart.
recipient_email - String
The email address of the person receiving the gift card.
recipient_name - String!
The name of the person receiving the gift card.
sender_email - String
The email address of the sender.
sender_name - String!
The name of the sender.
uid - ID!
The unique ID for a `CartItemInterface` object.

Example

Copied to your clipboard
{
  "amount": Money,
  "available_gift_wrapping": [GiftWrapping],
  "customizable_options": [SelectedCustomizableOption],
  "discount": [Discount],
  "errors": [CartItemError],
  "gift_message": GiftMessage,
  "gift_wrapping": GiftWrapping,
  "id": "abc123",
  "is_available": true,
  "max_qty": 123.45,
  "message": "abc123",
  "min_qty": 123.45,
  "not_available_message": "xyz789",
  "note_from_buyer": [ItemNote],
  "note_from_seller": [ItemNote],
  "prices": CartItemPrices,
  "product": ProductInterface,
  "quantity": 123.45,
  "recipient_email": "abc123",
  "recipient_name": "xyz789",
  "sender_email": "xyz789",
  "sender_name": "xyz789",
  "uid": 4
}

GiftCardCreditMemoItem

Fields

Field NameDescription
discounts - [Discount]
Details about the final discount amount for the base product, including discounts on options.
gift_card - GiftCardItem
Selected gift card properties for a credit memo item.
id - ID!
The unique ID for a `CreditMemoItemInterface` object.
order_item - OrderItemInterface
The order item the credit memo is applied to.
product_name - String
The name of the base product.
product_sale_price - Money!
The sale price for the base product, including selected options.
product_sku - String!
The SKU of the base product.
quantity_refunded - Float
The number of refunded items.

Example

Copied to your clipboard
{
  "discounts": [Discount],
  "gift_card": GiftCardItem,
  "id": 4,
  "order_item": OrderItemInterface,
  "product_name": "xyz789",
  "product_sale_price": Money,
  "product_sku": "xyz789",
  "quantity_refunded": 123.45
}

GiftCardInvoiceItem

Fields

Field NameDescription
discounts - [Discount]
Information about the final discount amount for the base product, including discounts on options.
gift_card - GiftCardItem
Selected gift card properties for an invoice item.
id - ID!
The unique ID for an `InvoiceItemInterface` object.
order_item - OrderItemInterface
Details about an individual order item.
product_name - String
The name of the base product.
product_sale_price - Money!
The sale price for the base product including selected options.
product_sku - String!
The SKU of the base product.
quantity_invoiced - Float
The number of invoiced items.

Example

Copied to your clipboard
{
  "discounts": [Discount],
  "gift_card": GiftCardItem,
  "id": "4",
  "order_item": OrderItemInterface,
  "product_name": "xyz789",
  "product_sale_price": Money,
  "product_sku": "xyz789",
  "quantity_invoiced": 987.65
}

GiftCardItem

Contains details about a gift card.

Fields

Field NameDescription
message - String
The message from the sender to the recipient.
recipient_email - String
The email address of the receiver of a virtual gift card.
recipient_name - String
The name of the receiver of a physical or virtual gift card.
sender_email - String
The email address of the sender of a virtual gift card.
sender_name - String
The name of the sender of a physical or virtual gift card.

Example

Copied to your clipboard
{
  "message": "abc123",
  "recipient_email": "xyz789",
  "recipient_name": "xyz789",
  "sender_email": "xyz789",
  "sender_name": "xyz789"
}

GiftCardOptions

Contains details about the sender, recipient, and amount of a gift card.

Fields

Field NameDescription
amount - Money
The amount and currency of the gift card.
custom_giftcard_amount - Money
The custom amount and currency of the gift card.
message - String
A message to the recipient.
recipient_email - String
The email address of the person receiving the gift card.
recipient_name - String
The name of the person receiving the gift card.
sender_email - String
The email address of the person sending the gift card.
sender_name - String
The name of the person sending the gift card.

Example

Copied to your clipboard
{
  "amount": Money,
  "custom_giftcard_amount": Money,
  "message": "xyz789",
  "recipient_email": "abc123",
  "recipient_name": "abc123",
  "sender_email": "xyz789",
  "sender_name": "abc123"
}

GiftCardOrderItem

Fields

Field NameDescription
discounts - [Discount]
The final discount information for the product.
eligible_for_return - Boolean
Indicates whether the order item is eligible to be in a return request.
entered_options - [OrderItemOption]
The entered option for the base product, such as a logo or image.
gift_card - GiftCardItem
Selected gift card properties for an order item.
gift_message - GiftMessage
The selected gift message for the order item
gift_wrapping - GiftWrapping
The selected gift wrapping for the order item.
id - ID!
The unique ID for an `OrderItemInterface` object.
prices - OrderItemPrices
Contains details about the price of the item, including taxes and discounts.
product - ProductInterface
The ProductInterface object, which contains details about the base product
product_name - String
The name of the base product.
product_sale_price - Money!
The sale price of the base product, including selected options.
product_sku - String!
The SKU of the base product.
product_type - String
The type of product, such as simple, configurable, etc.
product_url_key - String
URL key of the base product.
quantity_canceled - Float
The number of canceled items.
quantity_invoiced - Float
The number of invoiced items.
quantity_ordered - Float
The number of units ordered for this item.
quantity_refunded - Float
The number of refunded items.
quantity_return_requested - Float
The requested return quantity of the item.
quantity_returned - Float
The number of returned items.
quantity_shipped - Float
The number of shipped items.
selected_options - [OrderItemOption]
The selected options for the base product, such as color or size.
status - String
The status of the order item.

Example

Copied to your clipboard
{
  "discounts": [Discount],
  "eligible_for_return": false,
  "entered_options": [OrderItemOption],
  "gift_card": GiftCardItem,
  "gift_message": GiftMessage,
  "gift_wrapping": GiftWrapping,
  "id": 4,
  "prices": OrderItemPrices,
  "product": ProductInterface,
  "product_name": "xyz789",
  "product_sale_price": Money,
  "product_sku": "xyz789",
  "product_type": "xyz789",
  "product_url_key": "xyz789",
  "quantity_canceled": 987.65,
  "quantity_invoiced": 987.65,
  "quantity_ordered": 987.65,
  "quantity_refunded": 987.65,
  "quantity_return_requested": 987.65,
  "quantity_returned": 987.65,
  "quantity_shipped": 987.65,
  "selected_options": [OrderItemOption],
  "status": "abc123"
}

GiftCardProduct

Defines properties of a gift card.

Fields

Field NameDescription
allow_message - Boolean
Indicates whether the customer can provide a message to accompany the gift card.
allow_open_amount - Boolean
Indicates whether shoppers have the ability to set the value of the gift card.
attribute_set_id - Int
The attribute set assigned to the product. (Deprecated: The field should not be used on the storefront.)
canonical_url - String
The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.
categories - [CategoryInterface]
The categories assigned to a product.
color - Int
(Deprecated: Use the `custom_attributes` field instead.)
country_of_manufacture - String
The product's country of origin.
created_at - String
Timestamp indicating when the product was created. (Deprecated: The field should not be used on the storefront.)
crosssell_products - [ProductInterface]
An array of cross-sell products.
custom_attributesV2 - ProductCustomAttributes
Product custom attributes.
description - ComplexTextValue
Detailed information about the product. The value can include simple HTML tags.
gift_card_options - [CustomizableOptionInterface]!
An array of customizable gift card options.
gift_message_available - Boolean!
Returns a value indicating gift message availability for the product.
gift_wrapping_available - Boolean!
Returns a value indicating gift wrapping availability for the product.
gift_wrapping_price - Money
Returns value and currency indicating gift wrapping price for the product.
giftcard_amounts - [GiftCardAmounts]
An array that contains information about the values and ID of a gift card.
giftcard_type - GiftCardTypeEnum
An enumeration that specifies the type of gift card.
id - Int
The ID number assigned to the product. (Deprecated: Use the `uid` field instead.)
image - ProductImage
The relative path to the main image on the product page.
is_redeemable - Boolean
Indicates whether the customer can redeem the value on the card for cash.
is_returnable - String
Indicates whether the product can be returned.
lifetime - Int
The number of days after purchase until the gift card expires. A null value means there is no limit.
manufacturer - Int
A number representing the product's manufacturer. (Deprecated: Use the `custom_attributes` field instead.)
max_sale_qty - Float
Maximum Qty Allowed in Shopping Cart
media_gallery - [MediaGalleryInterface]
An array of media gallery objects.
media_gallery_entries - [MediaGalleryEntry]
An array of MediaGalleryEntry objects. (Deprecated: Use `media_gallery` instead.)
message_max_length - Int
The maximum number of characters the gift message can contain.
meta_description - String
A brief overview of the product for search results listings, maximum 255 characters.
meta_keyword - String
A comma-separated list of keywords that are visible only to search engines.
meta_title - String
A string that is displayed in the title bar and tab of the browser and in search results lists.
min_sale_qty - Float
Minimum Qty Allowed in Shopping Cart
name - String
The product name. Customers use this name to identify the product.
new_from_date - String
The beginning date for new product listings, and determines if the product is featured as a new product.
new_to_date - String
The end date for new product listings.
only_x_left_in_stock - Float
Product stock only x left count
open_amount_max - Float
The maximum acceptable value of an open amount gift card.
open_amount_min - Float
The minimum acceptable value of an open amount gift card.
options - [CustomizableOptionInterface]
An array of options for a customizable product.
options_container - String
If the product has multiple options, determines where they appear on the product page.
price - ProductPrices
Indicates the price of an item. (Deprecated: Use `price_range` for product price information.)
price_range - PriceRange!
The range of prices for the product
price_tiers - [TierPrice]
An array of `TierPrice` objects.
product_links - [ProductLinksInterface]
An array of `ProductLinks` objects.
quantity - Float
Amount of available stock
rating_summary - Float!
The average of all the ratings given to the product.
redirect_code - Int!
Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.
related_products - [ProductInterface]
An array of related products.
relative_url - String
The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.
review_count - Int!
The total count of all the reviews given to the product.
reviews - ProductReviews!
The list of products reviews.
short_description - ComplexTextValue
A short description of the product. Its use depends on the theme.
sku - String
A number or code assigned to a product to identify the product, options, price, and manufacturer.
small_image - ProductImage
The relative path to the small image, which is used on catalog pages.
special_from_date - String
The beginning date that a product has a special price. (Deprecated: The field should not be used on the storefront.)
special_price - Float
The discounted price of the product.
special_to_date - String
The end date for a product with a special price.
staged - Boolean!
Indicates whether the product is staged for a future campaign.
stock_status - ProductStockStatus
Stock status of the product
swatch_image - String
The file name of a swatch image.
thumbnail - ProductImage
The relative path to the product's thumbnail image.
tier_price - Float
The price when tier pricing is in effect and the items purchased threshold has been reached. (Deprecated: Use `price_tiers` for product tier price information.)
tier_prices - [ProductTierPrices]
An array of ProductTierPrices objects. (Deprecated: Use `price_tiers` for product tier price information.)
type - UrlRewriteEntityTypeEnum
One of PRODUCT, CATEGORY, or CMS_PAGE.
type_id - String
One of simple, virtual, bundle, downloadable, grouped, or configurable. (Deprecated: Use `__typename` instead.)
uid - ID!
The unique ID for a `ProductInterface` object.
updated_at - String
Timestamp indicating when the product was updated. (Deprecated: The field should not be used on the storefront.)
upsell_products - [ProductInterface]
An array of up-sell products.
url_key - String
The part of the URL that identifies the product
url_path - String
(Deprecated: Use product's `canonical_url` or url rewrites instead)
url_rewrites - [UrlRewrite]
URL rewrites list
url_suffix - String
The part of the product URL that is appended after the url key
websites - [Website]
An array of websites in which the product is available. (Deprecated: The field should not be used on the storefront.)
weight - Float
The weight of the item, in units defined by the store.

Example

Copied to your clipboard
{
  "allow_message": false,
  "allow_open_amount": false,
  "attribute_set_id": 123,
  "canonical_url": "xyz789",
  "categories": [CategoryInterface],
  "color": 987,
  "country_of_manufacture": "xyz789",
  "created_at": "abc123",
  "crosssell_products": [ProductInterface],
  "custom_attributesV2": ProductCustomAttributes,
  "description": ComplexTextValue,
  "gift_card_options": [CustomizableOptionInterface],
  "gift_message_available": true,
  "gift_wrapping_available": true,
  "gift_wrapping_price": Money,
  "giftcard_amounts": [GiftCardAmounts],
  "giftcard_type": "VIRTUAL",
  "id": 987,
  "image": ProductImage,
  "is_redeemable": true,
  "is_returnable": "abc123",
  "lifetime": 987,
  "manufacturer": 987,
  "max_sale_qty": 987.65,
  "media_gallery": [MediaGalleryInterface],
  "media_gallery_entries": [MediaGalleryEntry],
  "message_max_length": 987,
  "meta_description": "xyz789",
  "meta_keyword": "abc123",
  "meta_title": "abc123",
  "min_sale_qty": 123.45,
  "name": "xyz789",
  "new_from_date": "abc123",
  "new_to_date": "xyz789",
  "only_x_left_in_stock": 123.45,
  "open_amount_max": 987.65,
  "open_amount_min": 987.65,
  "options": [CustomizableOptionInterface],
  "options_container": "xyz789",
  "price": ProductPrices,
  "price_range": PriceRange,
  "price_tiers": [TierPrice],
  "product_links": [ProductLinksInterface],
  "quantity": 123.45,
  "rating_summary": 987.65,
  "redirect_code": 987,
  "related_products": [ProductInterface],
  "relative_url": "xyz789",
  "review_count": 123,
  "reviews": ProductReviews,
  "short_description": ComplexTextValue,
  "sku": "abc123",
  "small_image": ProductImage,
  "special_from_date": "xyz789",
  "special_price": 123.45,
  "special_to_date": "xyz789",
  "staged": true,
  "stock_status": "IN_STOCK",
  "swatch_image": "abc123",
  "thumbnail": ProductImage,
  "tier_price": 987.65,
  "tier_prices": [ProductTierPrices],
  "type": "CMS_PAGE",
  "type_id": "xyz789",
  "uid": "4",
  "updated_at": "xyz789",
  "upsell_products": [ProductInterface],
  "url_key": "xyz789",
  "url_path": "abc123",
  "url_rewrites": [UrlRewrite],
  "url_suffix": "xyz789",
  "websites": [Website],
  "weight": 987.65
}

GiftCardRequisitionListItem

Contains details about gift cards added to a requisition list.

Fields

Field NameDescription
customizable_options - [SelectedCustomizableOption]!
Selected custom options for an item in the requisition list.
gift_card_options - GiftCardOptions!
An array that defines gift card properties.
product - ProductInterface!
Details about a requisition list item.
quantity - Float!
The amount added.
uid - ID!
The unique ID for the requisition list item.

Example

Copied to your clipboard
{
  "customizable_options": [SelectedCustomizableOption],
  "gift_card_options": GiftCardOptions,
  "product": ProductInterface,
  "quantity": 987.65,
  "uid": "4"
}

GiftCardShipmentItem

Fields

Field NameDescription
gift_card - GiftCardItem
Selected gift card properties for a shipment item.
id - ID!
The unique ID for a `ShipmentItemInterface` object.
order_item - OrderItemInterface
The order item associated with the shipment item.
product_name - String
The name of the base product.
product_sale_price - Money!
The sale price for the base product.
product_sku - String!
The SKU of the base product.
quantity_shipped - Float!
The number of shipped items.

Example

Copied to your clipboard
{
  "gift_card": GiftCardItem,
  "id": "4",
  "order_item": OrderItemInterface,
  "product_name": "abc123",
  "product_sale_price": Money,
  "product_sku": "xyz789",
  "quantity_shipped": 123.45
}

GiftCardTypeEnum

Specifies the gift card type.

Values

Enum ValueDescription
VIRTUAL
PHYSICAL
COMBINED

Example

Copied to your clipboard
""VIRTUAL""

GiftCardWishlistItem

A single gift card added to a wish list.

Fields

Field NameDescription
added_at - String!
The date and time the item was added to the wish list.
customizable_options - [SelectedCustomizableOption]!
Custom options selected for the wish list item.
description - String
The description of the item.
gift_card_options - GiftCardOptions!
Details about a gift card.
id - ID!
The unique ID for a `WishlistItemInterface` object.
product - ProductInterface
Product details of the wish list item.
quantity - Float!
The quantity of this wish list item.

Example

Copied to your clipboard
{
  "added_at": "abc123",
  "customizable_options": [SelectedCustomizableOption],
  "description": "abc123",
  "gift_card_options": GiftCardOptions,
  "id": 4,
  "product": ProductInterface,
  "quantity": 987.65
}

GiftCartAttributeValue

Gift card custom attribute value containing array data.

Fields

Field NameDescription
code - ID!
The attribute code.
options - [String]!
Array of gift card attribute option values.

Example

Copied to your clipboard
{"code": 4, "options": ["abc123"]}

GiftMessage

Contains the text of a gift message, its sender, and recipient

Fields

Field NameDescription
from - String!
Sender name
message - String!
Gift message text
to - String!
Recipient name

Example

Copied to your clipboard
{
  "from": "xyz789",
  "message": "abc123",
  "to": "xyz789"
}

GiftMessageInput

Defines a gift message.

Input Fields

Input FieldDescription
from - String!
The name of the sender.
message - String!
The text of the gift message.
to - String!
The name of the recepient.

Example

Copied to your clipboard
{
  "from": "xyz789",
  "message": "abc123",
  "to": "xyz789"
}

GiftOptionsPrices

Contains prices for gift wrapping options.

Fields

Field NameDescription
gift_wrapping_for_items - Money
Price of the gift wrapping for all individual order items.
gift_wrapping_for_items_incl_tax - Money
Price of the gift wrapping for all individual order items including tax.
gift_wrapping_for_order - Money
Price of the gift wrapping for the whole order.
gift_wrapping_for_order_incl_tax - Money
Price of the gift wrapping for the whole order including tax.
printed_card - Money
Price for the printed card.
printed_card_incl_tax - Money
Price for the printed card including tax.

Example

Copied to your clipboard
{
  "gift_wrapping_for_items": Money,
  "gift_wrapping_for_items_incl_tax": Money,
  "gift_wrapping_for_order": Money,
  "gift_wrapping_for_order_incl_tax": Money,
  "printed_card": Money,
  "printed_card_incl_tax": Money
}

GiftRegistry

Contains details about a gift registry.

Fields

Field NameDescription
created_at - String!
The date on which the gift registry was created. Only the registry owner can access this attribute.
dynamic_attributes - [GiftRegistryDynamicAttribute]
An array of attributes that define elements of the gift registry. Each attribute is specified as a code-value pair.
event_name - String!
The name of the event.
items - [GiftRegistryItemInterface]
An array of products added to the gift registry.
message - String!
The message text the customer entered to describe the event.
owner_name - String!
The customer who created the gift registry.
privacy_settings - GiftRegistryPrivacySettings!
An enum that states whether the gift registry is PRIVATE or PUBLIC. Only the registry owner can access this attribute.
registrants - [GiftRegistryRegistrant]
Contains details about each registrant for the event.
shipping_address - CustomerAddress
Contains the customer's shipping address. Only the registry owner can access this attribute.
status - GiftRegistryStatus!
An enum that states whether the gift registry is ACTIVE or INACTIVE. Only the registry owner can access this attribute.
type - GiftRegistryType
The type of gift registry.
uid - ID!
The unique ID assigned to the gift registry.

Example

Copied to your clipboard
{
  "created_at": "xyz789",
  "dynamic_attributes": [GiftRegistryDynamicAttribute],
  "event_name": "abc123",
  "items": [GiftRegistryItemInterface],
  "message": "abc123",
  "owner_name": "xyz789",
  "privacy_settings": "PRIVATE",
  "registrants": [GiftRegistryRegistrant],
  "shipping_address": CustomerAddress,
  "status": "ACTIVE",
  "type": GiftRegistryType,
  "uid": "4"
}

GiftRegistryDynamicAttribute

Fields

Field NameDescription
code - ID!
The internal ID of the dynamic attribute.
group - GiftRegistryDynamicAttributeGroup!
Indicates which group the dynamic attribute is a member of.
label - String!
The display name of the dynamic attribute.
value - String!
A corresponding value for the code.

Example

Copied to your clipboard
{
  "code": 4,
  "group": "EVENT_INFORMATION",
  "label": "abc123",
  "value": "xyz789"
}

GiftRegistryDynamicAttributeGroup

Defines the group type of a gift registry dynamic attribute.

Values

Enum ValueDescription
EVENT_INFORMATION
PRIVACY_SETTINGS
REGISTRANT
GENERAL_INFORMATION
DETAILED_INFORMATION
SHIPPING_ADDRESS

Example

Copied to your clipboard
""EVENT_INFORMATION""

GiftRegistryDynamicAttributeInput

Defines a dynamic attribute.

Input Fields

Input FieldDescription
code - ID!
A unique key for an additional attribute of the event.
value - String!
A string that describes a dynamic attribute.

Example

Copied to your clipboard
{
  "code": "4",
  "value": "xyz789"
}

GiftRegistryDynamicAttributeInterface

Fields

Field NameDescription
code - ID!
The internal ID of the dynamic attribute.
label - String!
The display name of the dynamic attribute.
value - String!
A corresponding value for the code.

Possible Types

GiftRegistryDynamicAttributeInterface Types
GiftRegistryRegistrantDynamicAttribute
GiftRegistryDynamicAttribute

Example

Copied to your clipboard
{
  "code": "4",
  "label": "abc123",
  "value": "abc123"
}

GiftRegistryDynamicAttributeMetadata

Fields

Field NameDescription
attribute_group - String!
Indicates which group the dynamic attribute a member of.
code - ID!
The internal ID of the dynamic attribute.
input_type - String!
The selected input type for this dynamic attribute. The value can be one of several static or custom types.
is_required - Boolean!
Indicates whether the dynamic attribute is required.
label - String!
The display name of the dynamic attribute.
sort_order - Int
The order in which to display the dynamic attribute.

Example

Copied to your clipboard
{
  "attribute_group": "xyz789",
  "code": 4,
  "input_type": "abc123",
  "is_required": false,
  "label": "xyz789",
  "sort_order": 123
}

GiftRegistryDynamicAttributeMetadataInterface

Fields

Field NameDescription
attribute_group - String!
Indicates which group the dynamic attribute a member of.
code - ID!
The internal ID of the dynamic attribute.
input_type - String!
The selected input type for this dynamic attribute. The value can be one of several static or custom types.
is_required - Boolean!
Indicates whether the dynamic attribute is required.
label - String!
The display name of the dynamic attribute.
sort_order - Int
The order in which to display the dynamic attribute.

Possible Types

GiftRegistryDynamicAttributeMetadataInterface Types
GiftRegistryDynamicAttributeMetadata

Example

Copied to your clipboard
{
  "attribute_group": "xyz789",
  "code": "4",
  "input_type": "abc123",
  "is_required": true,
  "label": "abc123",
  "sort_order": 987
}

GiftRegistryItem

Fields

Field NameDescription
created_at - String!
The date the product was added to the gift registry.
note - String
A brief message about the gift registry item.
product - ProductInterface
Details about the gift registry item.
quantity - Float!
The requested quantity of the product.
quantity_fulfilled - Float!
The fulfilled quantity of the product.
uid - ID!
The unique ID of a gift registry item.

Example

Copied to your clipboard
{
  "created_at": "abc123",
  "note": "xyz789",
  "product": ProductInterface,
  "quantity": 123.45,
  "quantity_fulfilled": 123.45,
  "uid": "4"
}

GiftRegistryItemInterface

Fields

Field NameDescription
created_at - String!
The date the product was added to the gift registry.
note - String
A brief message about the gift registry item.
product - ProductInterface
Details about the gift registry item.
quantity - Float!
The requested quantity of the product.
quantity_fulfilled - Float!
The fulfilled quantity of the product.
uid - ID!
The unique ID of a gift registry item.

Possible Types

GiftRegistryItemInterface Types
GiftRegistryItem

Example

Copied to your clipboard
{
  "created_at": "xyz789",
  "note": "xyz789",
  "product": ProductInterface,
  "quantity": 987.65,
  "quantity_fulfilled": 123.45,
  "uid": "4"
}

GiftRegistryItemUserErrorInterface

Contains the status and any errors that encountered with the customer's gift register item.

Fields

Field NameDescription
status - Boolean!
Indicates whether the attempt to move the cart items to the gift registry was successful.
user_errors - [GiftRegistryItemsUserError]!
An array of errors encountered while moving items from the cart to the gift registry.

Possible Types

GiftRegistryItemUserErrorInterface Types
MoveCartItemsToGiftRegistryOutput

Example

Copied to your clipboard
{
  "status": false,
  "user_errors": [GiftRegistryItemsUserError]
}

GiftRegistryItemsUserError

Contains details about an error that occurred when processing a gift registry item.

Fields

Field NameDescription
code - GiftRegistryItemsUserErrorType!
An error code that describes the error encountered.
gift_registry_item_uid - ID
The unique ID of the gift registry item containing an error.
gift_registry_uid - ID
The unique ID of the `GiftRegistry` object containing an error.
message - String!
A localized error message.
product_uid - ID
The unique ID of the product containing an error.

Example

Copied to your clipboard
{
  "code": "OUT_OF_STOCK",
  "gift_registry_item_uid": "4",
  "gift_registry_uid": 4,
  "message": "xyz789",
  "product_uid": 4
}

GiftRegistryItemsUserErrorType

Defines the error type.

Values

Enum ValueDescription
OUT_OF_STOCK
Used for handling out of stock products.
NOT_FOUND
Used for exceptions like EntityNotFound.
UNDEFINED
Used for other exceptions, such as database connection failures.

Example

Copied to your clipboard
""OUT_OF_STOCK""

GiftRegistryOutputInterface

Contains the customer's gift registry.

Fields

Field NameDescription
gift_registry - GiftRegistry
The gift registry.

Possible Types

GiftRegistryOutputInterface Types
MoveCartItemsToGiftRegistryOutput

Example

Copied to your clipboard
{"gift_registry": GiftRegistry}

GiftRegistryPrivacySettings

Defines the privacy setting of the gift registry.

Values

Enum ValueDescription
PRIVATE
PUBLIC

Example

Copied to your clipboard
""PRIVATE""

GiftRegistryRegistrant

Contains details about a registrant.

Fields

Field NameDescription
dynamic_attributes - [GiftRegistryRegistrantDynamicAttribute]
An array of dynamic attributes assigned to the registrant.
email - String!
The email address of the registrant. Only the registry owner can access this attribute.
firstname - String!
The first name of the registrant.
lastname - String!
The last name of the registrant.
uid - ID!
The unique ID assigned to the registrant.

Example

Copied to your clipboard
{
  "dynamic_attributes": [
    GiftRegistryRegistrantDynamicAttribute
  ],
  "email": "xyz789",
  "firstname": "xyz789",
  "lastname": "xyz789",
  "uid": 4
}

GiftRegistryRegistrantDynamicAttribute

Fields

Field NameDescription
code - ID!
The internal ID of the dynamic attribute.
label - String!
The display name of the dynamic attribute.
value - String!
A corresponding value for the code.

Example

Copied to your clipboard
{
  "code": 4,
  "label": "xyz789",
  "value": "abc123"
}

GiftRegistrySearchResult

Contains the results of a gift registry search.

Fields

Field NameDescription
event_date - String
The date of the event.
event_title - String!
The title given to the event.
gift_registry_uid - ID!
The URL key of the gift registry.
location - String
The location of the event.
name - String!
The name of the gift registry owner.
type - String
The type of event being held.

Example

Copied to your clipboard
{
  "event_date": "abc123",
  "event_title": "abc123",
  "gift_registry_uid": "4",
  "location": "abc123",
  "name": "abc123",
  "type": "xyz789"
}

GiftRegistryShippingAddressInput

Defines a shipping address for a gift registry. Specify either address_data or the address_id. If both are provided, validation will fail.

Input Fields

Input FieldDescription
address_data - CustomerAddressInput
Defines the shipping address for this gift registry.
address_id - ID
The ID assigned to this customer address.
customer_address_uid - ID
The unique ID assigned to this customer address.

Example

Copied to your clipboard
{
  "address_data": CustomerAddressInput,
  "address_id": "4",
  "customer_address_uid": "4"
}

GiftRegistryStatus

Defines the status of the gift registry.

Values

Enum ValueDescription
ACTIVE
INACTIVE

Example

Copied to your clipboard
""ACTIVE""

GiftRegistryType

Contains details about a gift registry type.

Fields

Field NameDescription
dynamic_attributes_metadata - [GiftRegistryDynamicAttributeMetadataInterface]
An array of attributes that define elements of the gift registry. Each attribute is specified as a code-value pair.
label - String!
The label assigned to the gift registry type on the Admin.
uid - ID!
The unique ID assigned to the gift registry type.

Example

Copied to your clipboard
{
  "dynamic_attributes_metadata": [
    GiftRegistryDynamicAttributeMetadataInterface
  ],
  "label": "abc123",
  "uid": 4
}

GiftWrapping

Contains details about the selected or available gift wrapping options.

Fields

Field NameDescription
design - String!
The name of the gift wrapping design.
id - ID!
The unique ID for a `GiftWrapping` object. (Deprecated: Use `uid` instead)
image - GiftWrappingImage
The preview image for a gift wrapping option.
price - Money!
The gift wrapping price.
uid - ID!
The unique ID for a `GiftWrapping` object.

Example

Copied to your clipboard
{
  "design": "xyz789",
  "id": 4,
  "image": GiftWrappingImage,
  "price": Money,
  "uid": "4"
}

GiftWrappingImage

Points to an image associated with a gift wrapping option.

Fields

Field NameDescription
label - String!
The gift wrapping preview image label.
url - String!
The gift wrapping preview image URL.

Example

Copied to your clipboard
{
  "label": "xyz789",
  "url": "abc123"
}

GooglePayButtonStyles

Fields

Field NameDescription
color - String
The button color
height - Int
The button height in pixels
type - String
The button type

Example

Copied to your clipboard
{
  "color": "xyz789",
  "height": 987,
  "type": "xyz789"
}

GooglePayConfig

Fields

Field NameDescription
button_styles - GooglePayButtonStyles
The styles for the GooglePay Button configuration
code - String
The payment method code as defined in the payment gateway
is_visible - Boolean
Indicates whether the payment method is displayed
payment_intent - String
Defines the payment intent (Authorize or Capture
payment_source - String
The payment source for the payment method
sdk_params - [SDKParams]
The PayPal parameters required to load the JS SDK
sort_order - String
The relative order the payment method is displayed on the checkout page
three_ds_mode - ThreeDSMode
3DS mode
title - String
The name displayed for the payment method

Example

Copied to your clipboard
{
  "button_styles": GooglePayButtonStyles,
  "code": "abc123",
  "is_visible": false,
  "payment_intent": "abc123",
  "payment_source": "abc123",
  "sdk_params": [SDKParams],
  "sort_order": "xyz789",
  "three_ds_mode": "OFF",
  "title": "xyz789"
}

GooglePayMethodInput

Google Pay inputs

Input Fields

Input FieldDescription
payment_source - String
The payment source for the payment method
payments_order_id - String
The payment services order ID
paypal_order_id - String
PayPal order ID

Example

Copied to your clipboard
{
  "payment_source": "abc123",
  "payments_order_id": "xyz789",
  "paypal_order_id": "xyz789"
}

GroupedProduct

Defines a grouped product, which consists of simple standalone products that are presented as a group.

Fields

Field NameDescription
attribute_set_id - Int
The attribute set assigned to the product. (Deprecated: The field should not be used on the storefront.)
canonical_url - String
The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.
categories - [CategoryInterface]
The categories assigned to a product.
color - Int
(Deprecated: Use the `custom_attributes` field instead.)
country_of_manufacture - String
The product's country of origin.
created_at - String
Timestamp indicating when the product was created. (Deprecated: The field should not be used on the storefront.)
crosssell_products - [ProductInterface]
An array of cross-sell products.
custom_attributesV2 - ProductCustomAttributes
Product custom attributes.
description - ComplexTextValue
Detailed information about the product. The value can include simple HTML tags.
gift_message_available - Boolean!
Returns a value indicating gift message availability for the product.
gift_wrapping_available - Boolean!
Returns a value indicating gift wrapping availability for the product.
gift_wrapping_price - Money
Returns value and currency indicating gift wrapping price for the product.
id - Int
The ID number assigned to the product. (Deprecated: Use the `uid` field instead.)
image - ProductImage
The relative path to the main image on the product page.
is_returnable - String
Indicates whether the product can be returned.
items - [GroupedProductItem]
An array containing grouped product items.
manufacturer - Int
A number representing the product's manufacturer. (Deprecated: Use the `custom_attributes` field instead.)
max_sale_qty - Float
Maximum Qty Allowed in Shopping Cart
media_gallery - [MediaGalleryInterface]
An array of media gallery objects.
media_gallery_entries - [MediaGalleryEntry]
An array of MediaGalleryEntry objects. (Deprecated: Use `media_gallery` instead.)
meta_description - String
A brief overview of the product for search results listings, maximum 255 characters.
meta_keyword - String
A comma-separated list of keywords that are visible only to search engines.
meta_title - String
A string that is displayed in the title bar and tab of the browser and in search results lists.
min_sale_qty - Float
Minimum Qty Allowed in Shopping Cart
name - String
The product name. Customers use this name to identify the product.
new_from_date - String
The beginning date for new product listings, and determines if the product is featured as a new product.
new_to_date - String
The end date for new product listings.
only_x_left_in_stock - Float
Product stock only x left count
options_container - String
If the product has multiple options, determines where they appear on the product page.
price - ProductPrices
Indicates the price of an item. (Deprecated: Use `price_range` for product price information.)
price_range - PriceRange!
The range of prices for the product
price_tiers - [TierPrice]
An array of `TierPrice` objects.
product_links - [ProductLinksInterface]
An array of `ProductLinks` objects.
quantity - Float
Amount of available stock
rating_summary - Float!
The average of all the ratings given to the product.
redirect_code - Int!
Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.
related_products - [ProductInterface]
An array of related products.
relative_url - String
The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.
review_count - Int!
The total count of all the reviews given to the product.
reviews - ProductReviews!
The list of products reviews.
short_description - ComplexTextValue
A short description of the product. Its use depends on the theme.
sku - String
A number or code assigned to a product to identify the product, options, price, and manufacturer.
small_image - ProductImage
The relative path to the small image, which is used on catalog pages.
special_from_date - String
The beginning date that a product has a special price. (Deprecated: The field should not be used on the storefront.)
special_price - Float
The discounted price of the product.
special_to_date - String
The end date for a product with a special price.
staged - Boolean!
Indicates whether the product is staged for a future campaign.
stock_status - ProductStockStatus
Stock status of the product
swatch_image - String
The file name of a swatch image.
thumbnail - ProductImage
The relative path to the product's thumbnail image.
tier_price - Float
The price when tier pricing is in effect and the items purchased threshold has been reached. (Deprecated: Use `price_tiers` for product tier price information.)
tier_prices - [ProductTierPrices]
An array of ProductTierPrices objects. (Deprecated: Use `price_tiers` for product tier price information.)
type - UrlRewriteEntityTypeEnum
One of PRODUCT, CATEGORY, or CMS_PAGE.
type_id - String
One of simple, virtual, bundle, downloadable, grouped, or configurable. (Deprecated: Use `__typename` instead.)
uid - ID!
The unique ID for a `ProductInterface` object.
updated_at - String
Timestamp indicating when the product was updated. (Deprecated: The field should not be used on the storefront.)
upsell_products - [ProductInterface]
An array of up-sell products.
url_key - String
The part of the URL that identifies the product
url_path - String
(Deprecated: Use product's `canonical_url` or url rewrites instead)
url_rewrites - [UrlRewrite]
URL rewrites list
url_suffix - String
The part of the product URL that is appended after the url key
websites - [Website]
An array of websites in which the product is available. (Deprecated: The field should not be used on the storefront.)
weight - Float
The weight of the item, in units defined by the store.

Example

Copied to your clipboard
{
  "attribute_set_id": 987,
  "canonical_url": "xyz789",
  "categories": [CategoryInterface],
  "color": 123,
  "country_of_manufacture": "abc123",
  "created_at": "xyz789",
  "crosssell_products": [ProductInterface],
  "custom_attributesV2": ProductCustomAttributes,
  "description": ComplexTextValue,
  "gift_message_available": false,
  "gift_wrapping_available": false,
  "gift_wrapping_price": Money,
  "id": 123,
  "image": ProductImage,
  "is_returnable": "xyz789",
  "items": [GroupedProductItem],
  "manufacturer": 123,
  "max_sale_qty": 123.45,
  "media_gallery": [MediaGalleryInterface],
  "media_gallery_entries": [MediaGalleryEntry],
  "meta_description": "xyz789",
  "meta_keyword": "xyz789",
  "meta_title": "abc123",
  "min_sale_qty": 123.45,
  "name": "abc123",
  "new_from_date": "xyz789",
  "new_to_date": "abc123",
  "only_x_left_in_stock": 123.45,
  "options_container": "abc123",
  "price": ProductPrices,
  "price_range": PriceRange,
  "price_tiers": [TierPrice],
  "product_links": [ProductLinksInterface],
  "quantity": 123.45,
  "rating_summary": 987.65,
  "redirect_code": 123,
  "related_products": [ProductInterface],
  "relative_url": "xyz789",
  "review_count": 123,
  "reviews": ProductReviews,
  "short_description": ComplexTextValue,
  "sku": "abc123",
  "small_image": ProductImage,
  "special_from_date": "abc123",
  "special_price": 123.45,
  "special_to_date": "xyz789",
  "staged": true,
  "stock_status": "IN_STOCK",
  "swatch_image": "xyz789",
  "thumbnail": ProductImage,
  "tier_price": 987.65,
  "tier_prices": [ProductTierPrices],
  "type": "CMS_PAGE",
  "type_id": "xyz789",
  "uid": "4",
  "updated_at": "abc123",
  "upsell_products": [ProductInterface],
  "url_key": "abc123",
  "url_path": "xyz789",
  "url_rewrites": [UrlRewrite],
  "url_suffix": "xyz789",
  "websites": [Website],
  "weight": 123.45
}

GroupedProductItem

Contains information about an individual grouped product item.

Fields

Field NameDescription
position - Int
The relative position of this item compared to the other group items.
product - ProductInterface
Details about this product option.
qty - Float
The quantity of this grouped product item.

Example

Copied to your clipboard
{
  "position": 987,
  "product": ProductInterface,
  "qty": 987.65
}

GroupedProductWishlistItem

A grouped product wish list item.

Fields

Field NameDescription
added_at - String!
The date and time the item was added to the wish list.
customizable_options - [SelectedCustomizableOption]!
Custom options selected for the wish list item.
description - String
The description of the item.
id - ID!
The unique ID for a `WishlistItemInterface` object.
product - ProductInterface
Product details of the wish list item.
quantity - Float!
The quantity of this wish list item.

Example

Copied to your clipboard
{
  "added_at": "abc123",
  "customizable_options": [SelectedCustomizableOption],
  "description": "xyz789",
  "id": 4,
  "product": ProductInterface,
  "quantity": 987.65
}

GuestOrderCancelInput

Input to retrieve a guest order based on token.

Input Fields

Input FieldDescription
reason - String!
Cancellation reason.
token - String!
Order token.

Example

Copied to your clipboard
{
  "reason": "xyz789",
  "token": "xyz789"
}

GuestOrderInformationInput

Input to retrieve an order based on details.

Input Fields

Input FieldDescription
email - String!
Order billing address email.
lastname - String!
Order billing address lastname.
number - String!
Order number.

Example

Copied to your clipboard
{
  "email": "abc123",
  "lastname": "xyz789",
  "number": "xyz789"
}

HostedFieldsConfig

Fields

Field NameDescription
cc_vault_code - String
Vault payment method code
code - String
The payment method code as defined in the payment gateway
is_vault_enabled - Boolean
Card vault enabled
is_visible - Boolean
Indicates whether the payment method is displayed
payment_intent - String
Defines the payment intent (Authorize or Capture
payment_source - String
The payment source for the payment method
requires_card_details - Boolean
Card and bin details required
sdk_params - [SDKParams]
The PayPal parameters required to load the JS SDK
sort_order - String
The relative order the payment method is displayed on the checkout page
three_ds - Boolean
Whether 3DS is activated; true if 3DS mode is not OFF. (Deprecated: Use 'three_ds_mode' instead.)
three_ds_mode - ThreeDSMode
3DS mode
title - String
The name displayed for the payment method

Example

Copied to your clipboard
{
  "cc_vault_code": "abc123",
  "code": "xyz789",
  "is_vault_enabled": false,
  "is_visible": false,
  "payment_intent": "xyz789",
  "payment_source": "xyz789",
  "requires_card_details": false,
  "sdk_params": [SDKParams],
  "sort_order": "xyz789",
  "three_ds": true,
  "three_ds_mode": "OFF",
  "title": "abc123"
}

HostedFieldsInput

Hosted Fields payment inputs

Input Fields

Input FieldDescription
cardBin - String
Card bin number
cardExpiryMonth - String
Expiration month of the card
cardExpiryYear - String
Expiration year of the card
cardLast4 - String
Last four digits of the card
holderName - String
Name on the card
is_active_payment_token_enabler - Boolean
Indicates whether details about the shopper's credit/debit card should be tokenized for later usage. Required only if Vault is enabled for the Payment Services payment integration.
payment_source - String
The payment source for the payment method
payments_order_id - String
The payment services order ID
paypal_order_id - String
PayPal order ID

Example

Copied to your clipboard
{
  "cardBin": "abc123",
  "cardExpiryMonth": "abc123",
  "cardExpiryYear": "xyz789",
  "cardLast4": "xyz789",
  "holderName": "abc123",
  "is_active_payment_token_enabler": false,
  "payment_source": "abc123",
  "payments_order_id": "xyz789",
  "paypal_order_id": "abc123"
}

HostedProInput

Contains a set of relative URLs that PayPal uses in response to various actions during the authorization process. Magento prepends the base URL to this value to create a full URL. For example, if the full URL is https://www.example.com/path/to/page.html, the relative URL is path/to/page.html. Use this input for Payments Pro Hosted Solution payment method.

Input Fields

Input FieldDescription
cancel_url - String!
The relative URL of the page that PayPal redirects to when the buyer cancels the transaction in order to choose a different payment method. For example, if the full URL to this page is https://www.example.com/paypal/action/cancel.html, the relative URL is paypal/action/cancel.html.
return_url - String!
The relative URL of the final confirmation page that PayPal redirects to upon payment success. For example, if the full URL to this page is https://www.example.com/paypal/action/return.html, the relative URL is paypal/action/return.html.

Example

Copied to your clipboard
{
  "cancel_url": "xyz789",
  "return_url": "abc123"
}

HostedProUrl

Contains the secure URL used for the Payments Pro Hosted Solution payment method.

Fields

Field NameDescription
secure_form_url - String
The secure URL generated by PayPal.

Example

Copied to your clipboard
{"secure_form_url": "xyz789"}

HostedProUrlInput

Contains the required input to request the secure URL for Payments Pro Hosted Solution payment.

Input Fields

Input FieldDescription
cart_id - String!
The unique ID that identifies the shopper's cart.

Example

Copied to your clipboard
{"cart_id": "xyz789"}

HttpQueryParameter

Contains target path parameters.

Fields

Field NameDescription
name - String
A parameter name.
value - String
A parameter value.

Example

Copied to your clipboard
{
  "name": "xyz789",
  "value": "xyz789"
}

ID

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Example

Copied to your clipboard
"4"

ImageSwatchData

Fields

Field NameDescription
thumbnail - String
The URL assigned to the thumbnail of the swatch image.
value - String
The value can be represented as color (HEX code), image link, or text.

Example

Copied to your clipboard
{
  "thumbnail": "xyz789",
  "value": "abc123"
}

InputFilterEnum

List of templates/filters applied to customer attribute input.

Values

Enum ValueDescription
NONE
There are no templates or filters to be applied.
DATE
Forces attribute input to follow the date format.
TRIM
Strip whitespace (or other characters) from the beginning and end of the input.
STRIPTAGS
Strip HTML Tags.
ESCAPEHTML
Escape HTML Entities.

Example

Copied to your clipboard
""NONE""

InsufficientStockError

Fields

Field NameDescription
code - CartUserInputErrorType!
A cart-specific error code.
message - String!
A localized error message.
quantity - Float
Amount of available stock

Example

Copied to your clipboard
{
  "code": "PRODUCT_NOT_FOUND",
  "message": "xyz789",
  "quantity": 987.65
}

Int

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example

Copied to your clipboard
123

InternalError

Contains an error message when an internal error occurred.

Fields

Field NameDescription
message - String!
The returned error message.

Example

Copied to your clipboard
{"message": "xyz789"}

Invoice

Contains invoice details.

Fields

Field NameDescription
comments - [SalesCommentItem]
Comments on the invoice.
id - ID!
The unique ID for a `Invoice` object.
items - [InvoiceItemInterface]
Invoiced product details.
number - String!
Sequential invoice number.
total - InvoiceTotal
Invoice total amount details.

Example

Copied to your clipboard
{
  "comments": [SalesCommentItem],
  "id": 4,
  "items": [InvoiceItemInterface],
  "number": "xyz789",
  "total": InvoiceTotal
}

InvoiceItem

Fields

Field NameDescription
discounts - [Discount]
Information about the final discount amount for the base product, including discounts on options.
id - ID!
The unique ID for an `InvoiceItemInterface` object.
order_item - OrderItemInterface
Details about an individual order item.
product_name - String
The name of the base product.
product_sale_price - Money!
The sale price for the base product including selected options.
product_sku - String!
The SKU of the base product.
quantity_invoiced - Float
The number of invoiced items.

Example

Copied to your clipboard
{
  "discounts": [Discount],
  "id": 4,
  "order_item": OrderItemInterface,
  "product_name": "abc123",
  "product_sale_price": Money,
  "product_sku": "xyz789",
  "quantity_invoiced": 123.45
}

InvoiceItemInterface

Contains detailes about invoiced items.

Fields

Field NameDescription
discounts - [Discount]
Information about the final discount amount for the base product, including discounts on options.
id - ID!
The unique ID for an `InvoiceItemInterface` object.
order_item - OrderItemInterface
Details about an individual order item.
product_name - String
The name of the base product.
product_sale_price - Money!
The sale price for the base product including selected options.
product_sku - String!
The SKU of the base product.
quantity_invoiced - Float
The number of invoiced items.

Possible Types

InvoiceItemInterface Types
DownloadableInvoiceItem
BundleInvoiceItem
GiftCardInvoiceItem
InvoiceItem

Example

Copied to your clipboard
{
  "discounts": [Discount],
  "id": 4,
  "order_item": OrderItemInterface,
  "product_name": "xyz789",
  "product_sale_price": Money,
  "product_sku": "abc123",
  "quantity_invoiced": 123.45
}

InvoiceTotal

Contains price details from an invoice.

Fields

Field NameDescription
base_grand_total - Money!
The final base grand total amount in the base currency.
discounts - [Discount]
The applied discounts to the invoice.
grand_total - Money!
The final total amount, including shipping, discounts, and taxes.
shipping_handling - ShippingHandling
Details about the shipping and handling costs for the invoice.
subtotal - Money!
The subtotal of the invoice, excluding shipping, discounts, and taxes.
taxes - [TaxItem]
The invoice tax details.
total_shipping - Money!
The shipping amount for the invoice.
total_tax - Money!
The amount of tax applied to the invoice.

Example

Copied to your clipboard
{
  "base_grand_total": Money,
  "discounts": [Discount],
  "grand_total": Money,
  "shipping_handling": ShippingHandling,
  "subtotal": Money,
  "taxes": [TaxItem],
  "total_shipping": Money,
  "total_tax": Money
}

IsCompanyAdminEmailAvailableOutput

Contains the response of a company admin email validation query.

Fields

Field NameDescription
is_email_available - Boolean!
Indicates whether the specified email address can be used to create a company administrator.

Example

Copied to your clipboard
{"is_email_available": false}

IsCompanyEmailAvailableOutput

Contains the response of a company email validation query.

Fields

Field NameDescription
is_email_available - Boolean!
Indicates whether the specified email address can be used to create a company.

Example

Copied to your clipboard
{"is_email_available": true}

IsCompanyRoleNameAvailableOutput

Contains the response of a role name validation query.

Fields

Field NameDescription
is_role_name_available - Boolean!
Indicates whether the specified company role name is available.

Example

Copied to your clipboard
{"is_role_name_available": true}

IsCompanyUserEmailAvailableOutput

Contains the response of a company user email validation query.

Fields

Field NameDescription
is_email_available - Boolean!
Indicates whether the specified email address can be used to create a company user.

Example

Copied to your clipboard
{"is_email_available": true}

IsEmailAvailableOutput

Contains the result of the isEmailAvailable query.

Fields

Field NameDescription
is_email_available - Boolean
Indicates whether the specified email address can be used to create a customer.

Example

Copied to your clipboard
{"is_email_available": false}

ItemNote

The note object for quote line item.

Fields

Field NameDescription
created_at - String
Timestamp that reflects note creation date.
creator_id - Int
ID of the user who submitted a note.
creator_type - Int
Type of teh user who submitted a note.
negotiable_quote_item_uid - ID
The unique ID of a `CartItemInterface` object.
note - String
Note text.
note_uid - ID
The unique ID of a `ItemNote` object.

Example

Copied to your clipboard
{
  "created_at": "abc123",
  "creator_id": 987,
  "creator_type": 987,
  "negotiable_quote_item_uid": "4",
  "note": "xyz789",
  "note_uid": 4
}

ItemSelectedBundleOption

A list of options of the selected bundle product.

Fields

Field NameDescription
id - ID!
The unique ID for a `ItemSelectedBundleOption` object. (Deprecated: Use `uid` instead.)
label - String!
The label of the option.
uid - ID!
The unique ID for a `ItemSelectedBundleOption` object.
values - [ItemSelectedBundleOptionValue]
A list of products that represent the values of the parent option.

Example

Copied to your clipboard
{
  "id": 4,
  "label": "abc123",
  "uid": 4,
  "values": [ItemSelectedBundleOptionValue]
}

ItemSelectedBundleOptionValue

A list of values for the selected bundle product.

Fields

Field NameDescription
id - ID!
The unique ID for a `ItemSelectedBundleOptionValue` object. (Deprecated: Use `uid` instead.)
price - Money!
The price of the child bundle product.
product_name - String!
The name of the child bundle product.
product_sku - String!
The SKU of the child bundle product.
quantity - Float!
The number of this bundle product that were ordered.
uid - ID!
The unique ID for a `ItemSelectedBundleOptionValue` object.

Example

Copied to your clipboard
{
  "id": "4",
  "price": Money,
  "product_name": "abc123",
  "product_sku": "abc123",
  "quantity": 123.45,
  "uid": 4
}

KeyValue

Contains a key-value pair.

Fields

Field NameDescription
name - String
The name part of the key/value pair.
value - String
The value part of the key/value pair.

Example

Copied to your clipboard
{
  "name": "abc123",
  "value": "abc123"
}

LayerFilter

Contains information for rendering layered navigation.

Fields

Field NameDescription
filter_items - [LayerFilterItemInterface]
An array of filter items. (Deprecated: Use `Aggregation.options` instead.)
filter_items_count - Int
The count of filter items in filter group. (Deprecated: Use `Aggregation.count` instead.)
name - String
The name of a layered navigation filter. (Deprecated: Use `Aggregation.label` instead.)
request_var - String
The request variable name for a filter query. (Deprecated: Use `Aggregation.attribute_code` instead.)

Example

Copied to your clipboard
{
  "filter_items": [LayerFilterItemInterface],
  "filter_items_count": 987,
  "name": "abc123",
  "request_var": "xyz789"
}

LayerFilterItem

Fields

Field NameDescription
items_count - Int
The count of items per filter. (Deprecated: Use `AggregationOption.count` instead.)
label - String
The label for a filter. (Deprecated: Use `AggregationOption.label` instead.)
value_string - String
The value of a filter request variable to be used in query. (Deprecated: Use `AggregationOption.value` instead.)

Example

Copied to your clipboard
{
  "items_count": 123,
  "label": "abc123",
  "value_string": "xyz789"
}

LayerFilterItemInterface

Fields

Field NameDescription
items_count - Int
The count of items per filter. (Deprecated: Use `AggregationOption.count` instead.)
label - String
The label for a filter. (Deprecated: Use `AggregationOption.label` instead.)
value_string - String
The value of a filter request variable to be used in query. (Deprecated: Use `AggregationOption.value` instead.)

Possible Types

LayerFilterItemInterface Types
LayerFilterItem
SwatchLayerFilterItem

Example

Copied to your clipboard
{
  "items_count": 987,
  "label": "xyz789",
  "value_string": "xyz789"
}

LineItemNoteInput

Sets quote item note.

Input Fields

Input FieldDescription
note - String
The note text to be added.
quote_item_uid - ID!
The unique ID of a `CartLineItem` object.
quote_uid - ID!
The unique ID of a `NegotiableQuote` object.

Example

Copied to your clipboard
{
  "note": "abc123",
  "quote_item_uid": "4",
  "quote_uid": "4"
}

MediaGalleryEntry

Defines characteristics about images and videos associated with a specific product.

Fields

Field NameDescription
content - ProductMediaGalleryEntriesContent
Details about the content of the media gallery item.
disabled - Boolean
Indicates whether the image is hidden from view.
file - String
The path of the image on the server.
id - Int
The identifier assigned to the object. (Deprecated: Use `uid` instead.)
label - String
The alt text displayed on the storefront when the user points to the image.
media_type - String
Either `image` or `video`.
position - Int
The media item's position after it has been sorted.
types - [String]
Array of image types. It can have the following values: image, small_image, thumbnail.
uid - ID!
The unique ID for a `MediaGalleryEntry` object.
video_content - ProductMediaGalleryEntriesVideoContent
Details about the content of a video item.

Example

Copied to your clipboard
{
  "content": ProductMediaGalleryEntriesContent,
  "disabled": false,
  "file": "abc123",
  "id": 987,
  "label": "xyz789",
  "media_type": "abc123",
  "position": 123,
  "types": ["xyz789"],
  "uid": 4,
  "video_content": ProductMediaGalleryEntriesVideoContent
}

MediaGalleryInterface

Contains basic information about a product image or video.

Fields

Field NameDescription
disabled - Boolean
Indicates whether the image is hidden from view.
label - String
The label of the product image or video.
position - Int
The media item's position after it has been sorted.
types - [String]
Array of image types. It can have the following values: image, small_image, thumbnail.
url - String
The URL of the product image or video.

Possible Types

MediaGalleryInterface Types
ProductImage
ProductVideo

Example

Copied to your clipboard
{
  "disabled": false,
  "label": "abc123",
  "position": 987,
  "types": ["xyz789"],
  "url": "abc123"
}

Fields

Field NameDescription
type - String
The type of logo for the PayPal Pay Later messaging

Example

Copied to your clipboard
{"type": "xyz789"}

MessageStyles

Fields

Field NameDescription
layout - String
The message layout
logo - MessageStyleLogo
The message logo

Example

Copied to your clipboard
{
  "layout": "abc123",
  "logo": MessageStyleLogo
}

Money

Defines a monetary value, including a numeric value and a currency code.

Fields

Field NameDescription
currency - CurrencyEnum
A three-letter currency code, such as USD or EUR.
value - Float
A number expressing a monetary value.

Example

Copied to your clipboard
{"currency": "AFN", "value": 123.45}

MoveCartItemsToGiftRegistryOutput

Contains the customer's gift registry and any errors encountered.

Fields

Field NameDescription
gift_registry - GiftRegistry
The gift registry.
status - Boolean!
Indicates whether the attempt to move the cart items to the gift registry was successful.
user_errors - [GiftRegistryItemsUserError]!
An array of errors encountered while moving items from the cart to the gift registry.

Example

Copied to your clipboard
{
  "gift_registry": GiftRegistry,
  "status": true,
  "user_errors": [GiftRegistryItemsUserError]
}

MoveItemsBetweenRequisitionListsInput

An input object that defines the items in a requisition list to be moved.

Input Fields

Input FieldDescription
requisitionListItemUids - [ID]!
An array of IDs representing products moved from one requisition list to another.

Example

Copied to your clipboard
{"requisitionListItemUids": ["4"]}

MoveItemsBetweenRequisitionListsOutput

Output of the request to move items to another requisition list.

Fields

Field NameDescription
destination_requisition_list - RequisitionList
The destination requisition list after moving items.
source_requisition_list - RequisitionList
The source requisition list after moving items.

Example

Copied to your clipboard
{
  "destination_requisition_list": RequisitionList,
  "source_requisition_list": RequisitionList
}

MoveLineItemToRequisitionListInput

Move Line Item to Requisition List.

Input Fields

Input FieldDescription
quote_item_uid - ID!
The unique ID of a `CartLineItem` object.
quote_uid - ID!
The unique ID of a `NegotiableQuote` object.
requisition_list_uid - ID!
The unique ID of a requisition list.

Example

Copied to your clipboard
{
  "quote_item_uid": "4",
  "quote_uid": 4,
  "requisition_list_uid": 4
}

MoveLineItemToRequisitionListOutput

Contains the updated negotiable quote.

Fields

Field NameDescription
quote - NegotiableQuote
The negotiable quote after moving item to requisition list.

Example

Copied to your clipboard
{"quote": NegotiableQuote}

MoveProductsBetweenWishlistsOutput

Contains the source and target wish lists after moving products.

Fields

Field NameDescription
destination_wishlist - Wishlist!
The destination wish list after receiving products moved from the source wish list.
source_wishlist - Wishlist!
The source wish list after moving products from it.
user_errors - [WishListUserInputError]!
An array of errors encountered while moving products to a wish list.

Example

Copied to your clipboard
{
  "destination_wishlist": Wishlist,
  "source_wishlist": Wishlist,
  "user_errors": [WishListUserInputError]
}

NegotiableQuote

Contains details about a negotiable quote.

Fields

Field NameDescription
available_payment_methods - [AvailablePaymentMethod]
An array of payment methods that can be applied to the negotiable quote.
billing_address - NegotiableQuoteBillingAddress
The billing address applied to the negotiable quote.
buyer - NegotiableQuoteUser!
The first and last name of the buyer.
comments - [NegotiableQuoteComment]
A list of comments made by the buyer and seller.
created_at - String
Timestamp indicating when the negotiable quote was created.
email - String
The email address of the company user.
history - [NegotiableQuoteHistoryEntry]
A list of status and price changes for the negotiable quote.
is_virtual - Boolean!
Indicates whether the negotiable quote contains only virtual products.
items - [CartItemInterface]
The list of items in the negotiable quote.
name - String!
The title assigned to the negotiable quote.
prices - CartPrices
A set of subtotals and totals applied to the negotiable quote.
selected_payment_method - SelectedPaymentMethod
The payment method that was applied to the negotiable quote.
shipping_addresses - [NegotiableQuoteShippingAddress]!
A list of shipping addresses applied to the negotiable quote.
status - NegotiableQuoteStatus!
The status of the negotiable quote.
total_quantity - Float!
The total number of items in the negotiable quote.
uid - ID!
The unique ID of a `NegotiableQuote` object.
updated_at - String
Timestamp indicating when the negotiable quote was updated.

Example

Copied to your clipboard
{
  "available_payment_methods": [AvailablePaymentMethod],
  "billing_address": NegotiableQuoteBillingAddress,
  "buyer": NegotiableQuoteUser,
  "comments": [NegotiableQuoteComment],
  "created_at": "abc123",
  "email": "xyz789",
  "history": [NegotiableQuoteHistoryEntry],
  "is_virtual": true,
  "items": [CartItemInterface],
  "name": "abc123",
  "prices": CartPrices,
  "selected_payment_method": SelectedPaymentMethod,
  "shipping_addresses": [NegotiableQuoteShippingAddress],
  "status": "SUBMITTED",
  "total_quantity": 123.45,
  "uid": 4,
  "updated_at": "abc123"
}

NegotiableQuoteAddressCountry

Defines the company's country.

Fields

Field NameDescription
code - String!
The address country code.
label - String!
The display name of the region.

Example

Copied to your clipboard
{
  "code": "abc123",
  "label": "xyz789"
}

NegotiableQuoteAddressInput

Defines the billing or shipping address to be applied to the cart.

Input Fields

Input FieldDescription
city - String!
The city specified for the billing or shipping address.
company - String
The company name.
country_code - String!
The country code and label for the billing or shipping address.
firstname - String!
The first name of the company user.
lastname - String!
The last name of the company user.
postcode - String
The ZIP or postal code of the billing or shipping address.
region - String
A string that defines the state or province of the billing or shipping address.
region_id - Int
An integer that defines the state or province of the billing or shipping address.
save_in_address_book - Boolean
Determines whether to save the address in the customer's address book. The default value is true.
street - [String]!
An array containing the street for the billing or shipping address.
telephone - String
The telephone number for the billing or shipping address.

Example

Copied to your clipboard
{
  "city": "xyz789",
  "company": "xyz789",
  "country_code": "abc123",
  "firstname": "abc123",
  "lastname": "abc123",
  "postcode": "xyz789",
  "region": "abc123",
  "region_id": 123,
  "save_in_address_book": false,
  "street": ["xyz789"],
  "telephone": "xyz789"
}

NegotiableQuoteAddressInterface

Fields

Field NameDescription
city - String!
The company's city or town.
company - String
The company name associated with the shipping/billing address.
country - NegotiableQuoteAddressCountry!
The company's country.
firstname - String!
The first name of the company user.
lastname - String!
The last name of the company user.
postcode - String
The company's ZIP or postal code.
region - NegotiableQuoteAddressRegion
An object containing the region name, region code, and region ID.
street - [String]!
An array of strings that define the street number and name.
telephone - String
The customer's telephone number.

Possible Types

NegotiableQuoteAddressInterface Types
NegotiableQuoteShippingAddress
NegotiableQuoteBillingAddress

Example

Copied to your clipboard
{
  "city": "abc123",
  "company": "xyz789",
  "country": NegotiableQuoteAddressCountry,
  "firstname": "xyz789",
  "lastname": "xyz789",
  "postcode": "xyz789",
  "region": NegotiableQuoteAddressRegion,
  "street": ["abc123"],
  "telephone": "abc123"
}

NegotiableQuoteAddressRegion

Defines the company's state or province.

Fields

Field NameDescription
code - String
The address region code.
label - String
The display name of the region.
region_id - Int
The unique ID for a pre-defined region.

Example

Copied to your clipboard
{
  "code": "abc123",
  "label": "xyz789",
  "region_id": 987
}

NegotiableQuoteBillingAddress

Fields

Field NameDescription
city - String!
The company's city or town.
company - String
The company name associated with the shipping/billing address.
country - NegotiableQuoteAddressCountry!
The company's country.
firstname - String!
The first name of the company user.
lastname - String!
The last name of the company user.
postcode - String
The company's ZIP or postal code.
region - NegotiableQuoteAddressRegion
An object containing the region name, region code, and region ID.
street - [String]!
An array of strings that define the street number and name.
telephone - String
The customer's telephone number.

Example

Copied to your clipboard
{
  "city": "abc123",
  "company": "xyz789",
  "country": NegotiableQuoteAddressCountry,
  "firstname": "abc123",
  "lastname": "xyz789",
  "postcode": "abc123",
  "region": NegotiableQuoteAddressRegion,
  "street": ["abc123"],
  "telephone": "abc123"
}

NegotiableQuoteBillingAddressInput

Defines the billing address.

Input Fields

Input FieldDescription
address - NegotiableQuoteAddressInput
Defines a billing address.
customer_address_uid - ID
The unique ID of a `CustomerAddress` object.
same_as_shipping - Boolean
Indicates whether to set the billing address to be the same as the existing shipping address on the negotiable quote.
use_for_shipping - Boolean
Indicates whether to set the shipping address to be the same as this billing address.

Example

Copied to your clipboard
{
  "address": NegotiableQuoteAddressInput,
  "customer_address_uid": "4",
  "same_as_shipping": false,
  "use_for_shipping": false
}

NegotiableQuoteComment

Contains a single plain text comment from either the buyer or seller.

Fields

Field NameDescription
author - NegotiableQuoteUser!
The first and last name of the commenter.
created_at - String!
Timestamp indicating when the comment was created.
creator_type - NegotiableQuoteCommentCreatorType!
Indicates whether a buyer or seller commented.
text - String!
The plain text comment.
uid - ID!
The unique ID of a `NegotiableQuoteComment` object.

Example

Copied to your clipboard
{
  "author": NegotiableQuoteUser,
  "created_at": "xyz789",
  "creator_type": "BUYER",
  "text": "xyz789",
  "uid": 4
}

NegotiableQuoteCommentCreatorType

Values

Enum ValueDescription
BUYER
SELLER

Example

Copied to your clipboard
""BUYER""

NegotiableQuoteCommentInput

Contains the commend provided by the buyer.

Input Fields

Input FieldDescription
comment - String!
The comment provided by the buyer.

Example

Copied to your clipboard
{"comment": "abc123"}

NegotiableQuoteCustomLogChange

Contains custom log entries added by third-party extensions.

Fields

Field NameDescription
new_value - String!
The new entry content.
old_value - String
The previous entry in the custom log.
title - String!
The title of the custom log entry.

Example

Copied to your clipboard
{
  "new_value": "abc123",
  "old_value": "xyz789",
  "title": "xyz789"
}

NegotiableQuoteFilterInput

Defines a filter to limit the negotiable quotes to return.

Input Fields

Input FieldDescription
ids - FilterEqualTypeInput
Filter by the ID of one or more negotiable quotes.
name - FilterMatchTypeInput
Filter by the negotiable quote name.

Example

Copied to your clipboard
{
  "ids": FilterEqualTypeInput,
  "name": FilterMatchTypeInput
}

NegotiableQuoteHistoryChanges

Contains a list of changes to a negotiable quote.

Fields

Field NameDescription
comment_added - NegotiableQuoteHistoryCommentChange
The comment provided with a change in the negotiable quote history.
custom_changes - NegotiableQuoteCustomLogChange
Lists log entries added by third-party extensions.
expiration - NegotiableQuoteHistoryExpirationChange
The expiration date of the negotiable quote before and after a change in the quote history.
products_removed - NegotiableQuoteHistoryProductsRemovedChange
Lists products that were removed as a result of a change in the quote history.
statuses - NegotiableQuoteHistoryStatusesChange
The status before and after a change in the negotiable quote history.
total - NegotiableQuoteHistoryTotalChange
The total amount of the negotiable quote before and after a change in the quote history.

Example

Copied to your clipboard
{
  "comment_added": NegotiableQuoteHistoryCommentChange,
  "custom_changes": NegotiableQuoteCustomLogChange,
  "expiration": NegotiableQuoteHistoryExpirationChange,
  "products_removed": NegotiableQuoteHistoryProductsRemovedChange,
  "statuses": NegotiableQuoteHistoryStatusesChange,
  "total": NegotiableQuoteHistoryTotalChange
}

NegotiableQuoteHistoryCommentChange

Contains a comment submitted by a seller or buyer.

Fields

Field NameDescription
comment - String!
A plain text comment submitted by a seller or buyer.

Example

Copied to your clipboard
{"comment": "abc123"}

NegotiableQuoteHistoryEntry

Contains details about a change for a negotiable quote.

Fields

Field NameDescription
author - NegotiableQuoteUser!
The person who made a change in the status of the negotiable quote.
change_type - NegotiableQuoteHistoryEntryChangeType!
An enum that describes the why the entry in the negotiable quote history changed status.
changes - NegotiableQuoteHistoryChanges
The set of changes in the negotiable quote.
created_at - String
Timestamp indicating when the negotiable quote entry was created.
uid - ID!
The unique ID of a `NegotiableQuoteHistoryEntry` object.

Example

Copied to your clipboard
{
  "author": NegotiableQuoteUser,
  "change_type": "CREATED",
  "changes": NegotiableQuoteHistoryChanges,
  "created_at": "xyz789",
  "uid": 4
}

NegotiableQuoteHistoryEntryChangeType

Values

Enum ValueDescription
CREATED
UPDATED
CLOSED
UPDATED_BY_SYSTEM

Example

Copied to your clipboard
""CREATED""

NegotiableQuoteHistoryExpirationChange

Contains a new expiration date and the previous date.

Fields

Field NameDescription
new_expiration - String
The expiration date after the change. The value will be 'null' if not set.
old_expiration - String
The previous expiration date. The value will be 'null' if not previously set.

Example

Copied to your clipboard
{
  "new_expiration": "abc123",
  "old_expiration": "xyz789"
}

NegotiableQuoteHistoryProductsRemovedChange

Contains lists of products that have been removed from the catalog and negotiable quote.

Fields

Field NameDescription
products_removed_from_catalog - [ID]
A list of product IDs the seller removed from the catalog.
products_removed_from_quote - [ProductInterface]
A list of products removed from the negotiable quote by either the buyer or the seller.

Example

Copied to your clipboard
{
  "products_removed_from_catalog": ["4"],
  "products_removed_from_quote": [ProductInterface]
}

NegotiableQuoteHistoryStatusChange

Lists a new status change applied to a negotiable quote and the previous status.

Fields

Field NameDescription
new_status - NegotiableQuoteStatus!
The updated status.
old_status - NegotiableQuoteStatus
The previous status. The value will be null for the first history entry in a negotiable quote.

Example

Copied to your clipboard
{"new_status": "SUBMITTED", "old_status": "SUBMITTED"}

NegotiableQuoteHistoryStatusesChange

Contains a list of status changes that occurred for the negotiable quote.

Fields

Field NameDescription
changes - [NegotiableQuoteHistoryStatusChange]!
A list of status changes.

Example

Copied to your clipboard
{"changes": [NegotiableQuoteHistoryStatusChange]}

NegotiableQuoteHistoryTotalChange

Contains a new price and the previous price.

Fields

Field NameDescription
new_price - Money
The total price as a result of the change.
old_price - Money
The previous total price on the negotiable quote.

Example

Copied to your clipboard
{
  "new_price": Money,
  "old_price": Money
}

NegotiableQuoteInvalidStateError

An error indicating that an operation was attempted on a negotiable quote in an invalid state.

Fields

Field NameDescription
message - String!
The returned error message.

Example

Copied to your clipboard
{"message": "xyz789"}

NegotiableQuoteItemQuantityInput

Specifies the updated quantity of an item.

Input Fields

Input FieldDescription
quantity - Float!
The new quantity of the negotiable quote item.
quote_item_uid - ID!
The unique ID of a `CartItemInterface` object.

Example

Copied to your clipboard
{"quantity": 123.45, "quote_item_uid": "4"}

NegotiableQuotePaymentMethodInput

Defines the payment method to be applied to the negotiable quote.

Input Fields

Input FieldDescription
code - String!
Payment method code
purchase_order_number - String
The purchase order number. Optional for most payment methods.

Example

Copied to your clipboard
{
  "code": "xyz789",
  "purchase_order_number": "xyz789"
}

NegotiableQuoteReferenceDocumentLink

Contains a reference document link for a negotiable quote template.

Fields

Field NameDescription
document_identifier - String
The identifier of the reference document.
document_name - String!
The title of the reference document.
link_id - ID!
The unique ID of a reference document link.
reference_document_url - String!
The URL of the reference document.

Example

Copied to your clipboard
{
  "document_identifier": "abc123",
  "document_name": "abc123",
  "link_id": 4,
  "reference_document_url": "abc123"
}

NegotiableQuoteShippingAddress

Fields

Field NameDescription
available_shipping_methods - [AvailableShippingMethod]
An array of shipping methods available to the buyer.
city - String!
The company's city or town.
company - String
The company name associated with the shipping/billing address.
country - NegotiableQuoteAddressCountry!
The company's country.
firstname - String!
The first name of the company user.
lastname - String!
The last name of the company user.
postcode - String
The company's ZIP or postal code.
region - NegotiableQuoteAddressRegion
An object containing the region name, region code, and region ID.
selected_shipping_method - SelectedShippingMethod
The selected shipping method.
street - [String]!
An array of strings that define the street number and name.
telephone - String
The customer's telephone number.

Example

Copied to your clipboard
{
  "available_shipping_methods": [AvailableShippingMethod],
  "city": "xyz789",
  "company": "xyz789",
  "country": NegotiableQuoteAddressCountry,
  "firstname": "xyz789",
  "lastname": "abc123",
  "postcode": "xyz789",
  "region": NegotiableQuoteAddressRegion,
  "selected_shipping_method": SelectedShippingMethod,
  "street": ["xyz789"],
  "telephone": "xyz789"
}

NegotiableQuoteShippingAddressInput

Defines shipping addresses for the negotiable quote.

Input Fields

Input FieldDescription
address - NegotiableQuoteAddressInput
A shipping address.
customer_address_uid - ID
An ID from the company user's address book that uniquely identifies the address to be used for shipping.
customer_notes - String
Text provided by the company user.

Example

Copied to your clipboard
{
  "address": NegotiableQuoteAddressInput,
  "customer_address_uid": "4",
  "customer_notes": "xyz789"
}

NegotiableQuoteSortInput

Defines the field to use to sort a list of negotiable quotes.

Input Fields

Input FieldDescription
sort_direction - SortEnum!
Whether to return results in ascending or descending order.
sort_field - NegotiableQuoteSortableField!
The specified sort field.

Example

Copied to your clipboard
{"sort_direction": "ASC", "sort_field": "QUOTE_NAME"}

NegotiableQuoteSortableField

Values

Enum ValueDescription
QUOTE_NAME
Sorts negotiable quotes by name.
CREATED_AT
Sorts negotiable quotes by the dates they were created.
UPDATED_AT
Sorts negotiable quotes by the dates they were last modified.

Example

Copied to your clipboard
""QUOTE_NAME""

NegotiableQuoteStatus

Values

Enum ValueDescription
SUBMITTED
PENDING
UPDATED
OPEN
ORDERED
CLOSED
DECLINED
EXPIRED
DRAFT

Example

Copied to your clipboard
""SUBMITTED""

NegotiableQuoteTemplate

Contains details about a negotiable quote template.

Fields

Field NameDescription
buyer - NegotiableQuoteUser!
The first and last name of the buyer.
comments - [NegotiableQuoteComment]
A list of comments made by the buyer and seller.
expiration_date - String!
The expiration period of the negotiable quote template.
history - [NegotiableQuoteHistoryEntry]
A list of status and price changes for the negotiable quote template.
is_min_max_qty_used - Boolean!
Indicates whether the minimum and maximum quantity settings are used.
is_virtual - Boolean!
Indicates whether the negotiable quote template contains only virtual products.
items - [CartItemInterface]
The list of items in the negotiable quote template.
max_order_commitment - Int!
Commitment for maximum orders
min_order_commitment - Int!
Commitment for minimum orders
name - String!
The title assigned to the negotiable quote template.
notifications - [QuoteTemplateNotificationMessage]
A list of notifications for the negotiable quote template.
prices - CartPrices
A set of subtotals and totals applied to the negotiable quote template.
reference_document_links - [NegotiableQuoteReferenceDocumentLink]
A list of reference document links for the negotiable quote template.
shipping_addresses - [NegotiableQuoteShippingAddress]!
A list of shipping addresses applied to the negotiable quote template.
status - String!
The status of the negotiable quote template.
template_id - ID!
The unique ID of a `NegotiableQuoteTemplate` object.
total_quantity - Float!
The total number of items in the negotiable quote template.

Example

Copied to your clipboard
{
  "buyer": NegotiableQuoteUser,
  "comments": [NegotiableQuoteComment],
  "expiration_date": "xyz789",
  "history": [NegotiableQuoteHistoryEntry],
  "is_min_max_qty_used": false,
  "is_virtual": false,
  "items": [CartItemInterface],
  "max_order_commitment": 987,
  "min_order_commitment": 123,
  "name": "xyz789",
  "notifications": [QuoteTemplateNotificationMessage],
  "prices": CartPrices,
  "reference_document_links": [
    NegotiableQuoteReferenceDocumentLink
  ],
  "shipping_addresses": [NegotiableQuoteShippingAddress],
  "status": "abc123",
  "template_id": 4,
  "total_quantity": 987.65
}

NegotiableQuoteTemplateFilterInput

Defines a filter to limit the negotiable quotes to return.

Input Fields

Input FieldDescription
state - FilterEqualTypeInput
Filter by state of one or more negotiable quote templates.
status - FilterEqualTypeInput
Filter by status of one or more negotiable quote templates.

Example

Copied to your clipboard
{
  "state": FilterEqualTypeInput,
  "status": FilterEqualTypeInput
}

NegotiableQuoteTemplateGridItem

Contains data for a negotiable quote template in a grid.

Fields

Field NameDescription
activated_at - String!
The date and time the negotiable quote template was activated.
company_name - String!
Company name the quote template is assigned to
expiration_date - String!
The expiration period of the negotiable quote template.
is_min_max_qty_used - Boolean!
Indicates whether the minimum and maximum quantity settings are used.
last_shared_at - String!
The date and time the negotiable quote template was last shared.
max_order_commitment - Int!
Commitment for maximum orders
min_negotiated_grand_total - Float!
The minimum negotiated grand total of the negotiable quote template.
min_order_commitment - Int!
Commitment for minimum orders
name - String!
The title assigned to the negotiable quote template.
orders_placed - Int!
The number of orders placed for the negotiable quote template.
sales_rep_name - String!
The first and last name of the sales representative.
state - String!
State of the negotiable quote template.
status - String!
The status of the negotiable quote template.
submitted_by - String!
The first and last name of the buyer.
template_id - ID!
The unique ID of a `NegotiableQuoteTemplate` object.

Example

Copied to your clipboard
{
  "activated_at": "abc123",
  "company_name": "abc123",
  "expiration_date": "xyz789",
  "is_min_max_qty_used": true,
  "last_shared_at": "xyz789",
  "max_order_commitment": 123,
  "min_negotiated_grand_total": 123.45,
  "min_order_commitment": 123,
  "name": "abc123",
  "orders_placed": 123,
  "sales_rep_name": "abc123",
  "state": "abc123",
  "status": "xyz789",
  "submitted_by": "abc123",
  "template_id": 4
}

NegotiableQuoteTemplateItemQuantityInput

Specifies the updated quantity of an item.

Input Fields

Input FieldDescription
item_id - ID!
The unique ID of a `CartItemInterface` object.
max_qty - Float
The new max quantity of the negotiable quote template item. Only used if is_min_max_qty_used is true on the template.
min_qty - Float
The new min quantity of the negotiable quote template item. Only used if is_min_max_qty_used is true on the template.
quantity - Float!
The new quantity of the negotiable quote item.

Example

Copied to your clipboard
{"item_id": 4, "max_qty": 987.65, "min_qty": 987.65, "quantity": 123.45}

NegotiableQuoteTemplateReferenceDocumentLinkInput

Defines the reference document link to add to a negotiable quote template.

Input Fields

Input FieldDescription
document_identifier - String
The identifier of the reference document.
document_name - String!
The title of the reference document.
link_id - ID
The unique ID of a `NegotiableQuoteReferenceDocumentLink` object.
reference_document_url - String!
The URL of the reference document.

Example

Copied to your clipboard
{
  "document_identifier": "xyz789",
  "document_name": "xyz789",
  "link_id": "4",
  "reference_document_url": "abc123"
}

NegotiableQuoteTemplateShippingAddressInput

Defines shipping addresses for the negotiable quote template.

Input Fields

Input FieldDescription
address - NegotiableQuoteAddressInput
A shipping address.
customer_address_uid - ID
An ID from the company user's address book that uniquely identifies the address to be used for shipping.
customer_notes - String
Text provided by the company user.

Example

Copied to your clipboard
{
  "address": NegotiableQuoteAddressInput,
  "customer_address_uid": "4",
  "customer_notes": "abc123"
}

NegotiableQuoteTemplateSortInput

Defines the field to use to sort a list of negotiable quotes.

Input Fields

Input FieldDescription
sort_direction - SortEnum!
Whether to return results in ascending or descending order.
sort_field - NegotiableQuoteTemplateSortableField!
The specified sort field.

Example

Copied to your clipboard
{"sort_direction": "ASC", "sort_field": "TEMPLATE_ID"}

NegotiableQuoteTemplateSortableField

Values

Enum ValueDescription
TEMPLATE_ID
Sorts negotiable quote templates by template id.
LAST_SHARED_AT
Sorts negotiable quote templates by the date they were last shared.

Example

Copied to your clipboard
""TEMPLATE_ID""

NegotiableQuoteTemplatesOutput

Contains a list of negotiable templates that match the specified filter.

Fields

Field NameDescription
items - [NegotiableQuoteTemplateGridItem]!
A list of negotiable quote templates
page_info - SearchResultPageInfo!
Contains pagination metadata
sort_fields - SortFields
Contains the default sort field and all available sort fields.
total_count - Int!
The number of negotiable quote templates returned

Example

Copied to your clipboard
{
  "items": [NegotiableQuoteTemplateGridItem],
  "page_info": SearchResultPageInfo,
  "sort_fields": SortFields,
  "total_count": 987
}

NegotiableQuoteUidNonFatalResultInterface

Fields

Field NameDescription
quote_uid - ID!
The unique ID of a `NegotiableQuote` object.

Possible Types

NegotiableQuoteUidNonFatalResultInterface Types
NegotiableQuoteUidOperationSuccess

Example

Copied to your clipboard
{"quote_uid": "4"}

NegotiableQuoteUidOperationSuccess

Contains details about a successful operation on a negotiable quote.

Fields

Field NameDescription
quote_uid - ID!
The unique ID of a `NegotiableQuote` object.

Example

Copied to your clipboard
{"quote_uid": 4}

NegotiableQuoteUser

A limited view of a Buyer or Seller in the negotiable quote process.

Fields

Field NameDescription
firstname - String!
The first name of the buyer or seller making a change.
lastname - String!
The buyer's or seller's last name.

Example

Copied to your clipboard
{
  "firstname": "abc123",
  "lastname": "abc123"
}

NegotiableQuotesOutput

Contains a list of negotiable that match the specified filter.

Fields

Field NameDescription
items - [NegotiableQuote]!
A list of negotiable quotes
page_info - SearchResultPageInfo!
Contains pagination metadata
sort_fields - SortFields
Contains the default sort field and all available sort fields.
total_count - Int!
The number of negotiable quotes returned

Example

Copied to your clipboard
{
  "items": [NegotiableQuote],
  "page_info": SearchResultPageInfo,
  "sort_fields": SortFields,
  "total_count": 987
}

NoSuchEntityUidError

Contains an error message when an invalid UID was specified.

Fields

Field NameDescription
message - String!
The returned error message.
uid - ID!
The specified invalid unique ID of an object.

Example

Copied to your clipboard
{
  "message": "xyz789",
  "uid": "4"
}

OpenNegotiableQuoteTemplateInput

Specifies the quote template id to open quote template.

Input Fields

Input FieldDescription
template_id - ID!
The unique ID of a `NegotiableQuoteTemplate` object.

Example

Copied to your clipboard
{"template_id": "4"}

Order

Contains the order ID.

Fields

Field NameDescription
order_id - String
(Deprecated: Use `order_number` instead.)
order_number - String!
The unique ID for an `Order` object.

Example

Copied to your clipboard
{
  "order_id": "xyz789",
  "order_number": "abc123"
}

OrderActionType

The list of available order actions.

Values

Enum ValueDescription
REORDER
CANCEL
RETURN

Example

Copied to your clipboard
""REORDER""

OrderAddress

Contains detailed information about an order's billing and shipping addresses.

Fields

Field NameDescription
city - String!
The city or town.
company - String
The customer's company.
country_code - CountryCodeEnum
The customer's country.
custom_attributesV2 - [AttributeValueInterface]!
Custom attributes assigned to the customer address.
fax - String
The fax number.
firstname - String!
The first name of the person associated with the shipping/billing address.
lastname - String!
The family name of the person associated with the shipping/billing address.
middlename - String
The middle name of the person associated with the shipping/billing address.
postcode - String
The customer's ZIP or postal code.
prefix - String
An honorific, such as Dr., Mr., or Mrs.
region - String
The state or province name.
region_id - ID
The unique ID for a `Region` object of a pre-defined region.
street - [String]!
An array of strings that define the street number and name.
suffix - String
A value such as Sr., Jr., or III.
telephone - String
The telephone number.
vat_id - String
The customer's Value-added tax (VAT) number (for corporate customers).

Example

Copied to your clipboard
{
  "city": "xyz789",
  "company": "abc123",
  "country_code": "AF",
  "custom_attributesV2": [AttributeValueInterface],
  "fax": "abc123",
  "firstname": "xyz789",
  "lastname": "xyz789",
  "middlename": "abc123",
  "postcode": "xyz789",
  "prefix": "xyz789",
  "region": "abc123",
  "region_id": 4,
  "street": ["abc123"],
  "suffix": "abc123",
  "telephone": "xyz789",
  "vat_id": "abc123"
}

OrderCustomerInfo

Fields

Field NameDescription
firstname - String!
First name of the customer
lastname - String
Last name of the customer
middlename - String
Middle name of the customer
prefix - String
Prefix of the customer
suffix - String
Suffix of the customer

Example

Copied to your clipboard
{
  "firstname": "abc123",
  "lastname": "abc123",
  "middlename": "abc123",
  "prefix": "xyz789",
  "suffix": "abc123"
}

OrderItem

Fields

Field NameDescription
discounts - [Discount]
The final discount information for the product.
eligible_for_return - Boolean
Indicates whether the order item is eligible to be in a return request.
entered_options - [OrderItemOption]
The entered option for the base product, such as a logo or image.
gift_message - GiftMessage
The selected gift message for the order item
gift_wrapping - GiftWrapping
The selected gift wrapping for the order item.
id - ID!
The unique ID for an `OrderItemInterface` object.
prices - OrderItemPrices
Contains details about the price of the item, including taxes and discounts.
product - ProductInterface
The ProductInterface object, which contains details about the base product
product_name - String
The name of the base product.
product_sale_price - Money!
The sale price of the base product, including selected options.
product_sku - String!
The SKU of the base product.
product_type - String
The type of product, such as simple, configurable, etc.
product_url_key - String
URL key of the base product.
quantity_canceled - Float
The number of canceled items.
quantity_invoiced - Float
The number of invoiced items.
quantity_ordered - Float
The number of units ordered for this item.
quantity_refunded - Float
The number of refunded items.
quantity_return_requested - Float
The requested return quantity of the item.
quantity_returned - Float
The number of returned items.
quantity_shipped - Float
The number of shipped items.
selected_options - [OrderItemOption]
The selected options for the base product, such as color or size.
status - String
The status of the order item.

Example

Copied to your clipboard
{
  "discounts": [Discount],
  "eligible_for_return": false,
  "entered_options": [OrderItemOption],
  "gift_message": GiftMessage,
  "gift_wrapping": GiftWrapping,
  "id": "4",
  "prices": OrderItemPrices,
  "product": ProductInterface,
  "product_name": "abc123",
  "product_sale_price": Money,
  "product_sku": "abc123",
  "product_type": "abc123",
  "product_url_key": "xyz789",
  "quantity_canceled": 123.45,
  "quantity_invoiced": 123.45,
  "quantity_ordered": 987.65,
  "quantity_refunded": 123.45,
  "quantity_return_requested": 987.65,
  "quantity_returned": 987.65,
  "quantity_shipped": 987.65,
  "selected_options": [OrderItemOption],
  "status": "xyz789"
}

OrderItemInterface

Order item details.

Fields

Field NameDescription
discounts - [Discount]
The final discount information for the product.
eligible_for_return - Boolean
Indicates whether the order item is eligible to be in a return request.
entered_options - [OrderItemOption]
The entered option for the base product, such as a logo or image.
gift_message - GiftMessage
The selected gift message for the order item
gift_wrapping - GiftWrapping
The selected gift wrapping for the order item.
id - ID!
The unique ID for an `OrderItemInterface` object.
prices - OrderItemPrices
Contains details about the price of the item, including taxes and discounts.
product - ProductInterface
The ProductInterface object, which contains details about the base product
product_name - String
The name of the base product.
product_sale_price - Money!
The sale price of the base product, including selected options.
product_sku - String!
The SKU of the base product.
product_type - String
The type of product, such as simple, configurable, etc.
product_url_key - String
URL key of the base product.
quantity_canceled - Float
The number of canceled items.
quantity_invoiced - Float
The number of invoiced items.
quantity_ordered - Float
The number of units ordered for this item.
quantity_refunded - Float
The number of refunded items.
quantity_return_requested - Float
The requested return quantity of the item.
quantity_returned - Float
The number of returned items.
quantity_shipped - Float
The number of shipped items.
selected_options - [OrderItemOption]
The selected options for the base product, such as color or size.
status - String
The status of the order item.

Possible Types

OrderItemInterface Types
ConfigurableOrderItem
DownloadableOrderItem
BundleOrderItem
GiftCardOrderItem
OrderItem

Example

Copied to your clipboard
{
  "discounts": [Discount],
  "eligible_for_return": false,
  "entered_options": [OrderItemOption],
  "gift_message": GiftMessage,
  "gift_wrapping": GiftWrapping,
  "id": "4",
  "prices": OrderItemPrices,
  "product": ProductInterface,
  "product_name": "xyz789",
  "product_sale_price": Money,
  "product_sku": "xyz789",
  "product_type": "xyz789",
  "product_url_key": "abc123",
  "quantity_canceled": 123.45,
  "quantity_invoiced": 987.65,
  "quantity_ordered": 987.65,
  "quantity_refunded": 123.45,
  "quantity_return_requested": 987.65,
  "quantity_returned": 123.45,
  "quantity_shipped": 123.45,
  "selected_options": [OrderItemOption],
  "status": "xyz789"
}

OrderItemOption

Represents order item options like selected or entered.

Fields

Field NameDescription
label - String!
The name of the option.
value - String!
The value of the option.

Example

Copied to your clipboard
{
  "label": "xyz789",
  "value": "abc123"
}

OrderItemPrices

Fields

Field NameDescription
discounts - [Discount]
An array of discounts to be applied to the cart item.
fixed_product_taxes - [FixedProductTax]!
original_price - Money
The original price of the item.
original_price_including_tax - Money
The original price of the item including tax.
original_row_total - Money!
The value of the original price multiplied by the quantity of the item.
original_row_total_including_tax - Money!
The value of the original price multiplied by the quantity of the item including tax.
price - Money!
The price of the item before any discounts were applied. The price that might include tax, depending on the configured display settings for cart.
price_including_tax - Money!
The price of the item before any discounts were applied. The price that might include tax, depending on the configured display settings for cart.
row_total - Money!
The value of the price multiplied by the quantity of the item.
row_total_including_tax - Money!
The value of `row_total` plus the tax applied to the item.
total_item_discount - Money!
The total of all discounts applied to the item.

Example

Copied to your clipboard
{
  "discounts": [Discount],
  "fixed_product_taxes": [FixedProductTax],
  "original_price": Money,
  "original_price_including_tax": Money,
  "original_row_total": Money,
  "original_row_total_including_tax": Money,
  "price": Money,
  "price_including_tax": Money,
  "row_total": Money,
  "row_total_including_tax": Money,
  "total_item_discount": Money
}

OrderPaymentMethod

Contains details about the payment method used to pay for the order.

Fields

Field NameDescription
additional_data - [KeyValue]
Additional data per payment method type.
name - String!
The label that describes the payment method.
type - String!
The payment method code that indicates how the order was paid for.

Example

Copied to your clipboard
{
  "additional_data": [KeyValue],
  "name": "abc123",
  "type": "abc123"
}

OrderShipment

Contains order shipment details.

Fields

Field NameDescription
comments - [SalesCommentItem]
Comments added to the shipment.
id - ID!
The unique ID for a `OrderShipment` object.
items - [ShipmentItemInterface]
An array of items included in the shipment.
number - String!
The sequential credit shipment number.
tracking - [ShipmentTracking]
An array of shipment tracking details.

Example

Copied to your clipboard
{
  "comments": [SalesCommentItem],
  "id": 4,
  "items": [ShipmentItemInterface],
  "number": "abc123",
  "tracking": [ShipmentTracking]
}

OrderTokenInput

Input to retrieve an order based on token.

Input Fields

Input FieldDescription
token - String!
Order token.

Example

Copied to your clipboard
{"token": "abc123"}

OrderTotal

Contains details about the sales total amounts used to calculate the final price.

Fields

Field NameDescription
base_grand_total - Money!
The final base grand total amount in the base currency.
discounts - [Discount]
The applied discounts to the order.
gift_options - GiftOptionsPrices
grand_total - Money!
The final total amount, including shipping, discounts, and taxes.
grand_total_excl_tax - Money!
The grand total of the order, excluding taxes.
shipping_handling - ShippingHandling
Details about the shipping and handling costs for the order.
subtotal - Money!
The subtotal of the order, excluding shipping, discounts, and taxes. (Deprecated: Use subtotal_excl_tax field instead)
subtotal_excl_tax - Money!
The subtotal of the order, excluding taxes.
subtotal_incl_tax - Money!
The subtotal of the order, including taxes.
taxes - [TaxItem]
The order tax details.
total_giftcard - Money
The gift card balance applied to the order.
total_reward_points - Money
The total reward points applied to the order.
total_shipping - Money!
The shipping amount for the order.
total_store_credit - Money
The total store credit applied to the order.
total_tax - Money!
The amount of tax applied to the order.

Example

Copied to your clipboard
{
  "base_grand_total": Money,
  "discounts": [Discount],
  "gift_options": GiftOptionsPrices,
  "grand_total": Money,
  "grand_total_excl_tax": Money,
  "shipping_handling": ShippingHandling,
  "subtotal": Money,
  "subtotal_excl_tax": Money,
  "subtotal_incl_tax": Money,
  "taxes": [TaxItem],
  "total_giftcard": Money,
  "total_reward_points": Money,
  "total_shipping": Money,
  "total_store_credit": Money,
  "total_tax": Money
}

PayflowExpressInput

Contains required input for Payflow Express Checkout payments.

Input Fields

Input FieldDescription
payer_id - String!
The unique ID of the PayPal user.
token - String!
The token returned by the createPaypalExpressToken mutation.

Example

Copied to your clipboard
{
  "payer_id": "abc123",
  "token": "abc123"
}

PayflowLinkInput

A set of relative URLs that PayPal uses in response to various actions during the authorization process. Adobe Commerce prepends the base URL to this value to create a full URL. For example, if the full URL is https://www.example.com/path/to/page.html, the relative URL is path/to/page.html. Use this input for Payflow Link and Payments Advanced payment methods.

Input Fields

Input FieldDescription
cancel_url - String!
The relative URL of the page that PayPal redirects to when the buyer cancels the transaction in order to choose a different payment method. If the full URL to this page is https://www.example.com/paypal/action/cancel.html, the relative URL is paypal/action/cancel.html.
error_url - String!
The relative URL of the transaction error page that PayPal redirects to upon payment error. If the full URL to this page is https://www.example.com/paypal/action/error.html, the relative URL is paypal/action/error.html.
return_url - String!
The relative URL of the order confirmation page that PayPal redirects to when the payment is successful and additional confirmation is not needed. If the full URL to this page is https://www.example.com/paypal/action/return.html, the relative URL is paypal/action/return.html.

Example

Copied to your clipboard
{
  "cancel_url": "abc123",
  "error_url": "xyz789",
  "return_url": "abc123"
}

PayflowLinkMode

Indicates the mode for payment. Applies to the Payflow Link and Payments Advanced payment methods.

Values

Enum ValueDescription
TEST
LIVE

Example

Copied to your clipboard
""TEST""

PayflowLinkToken

Contains information used to generate PayPal iframe for transaction. Applies to Payflow Link and Payments Advanced payment methods.

Fields

Field NameDescription
mode - PayflowLinkMode
The mode for the Payflow transaction.
paypal_url - String
The PayPal URL used for requesting a Payflow form.
secure_token - String
The secure token generated by PayPal.
secure_token_id - String
The secure token ID generated by PayPal.

Example

Copied to your clipboard
{
  "mode": "TEST",
  "paypal_url": "abc123",
  "secure_token": "xyz789",
  "secure_token_id": "abc123"
}

PayflowLinkTokenInput

Contains information required to fetch payment token information for the Payflow Link and Payments Advanced payment methods.

Input Fields

Input FieldDescription
cart_id - String!
The unique ID that identifies the customer's cart.

Example

Copied to your clipboard
{"cart_id": "xyz789"}

PayflowProInput

Contains input for the Payflow Pro and Payments Pro payment methods.

Input Fields

Input FieldDescription
cc_details - CreditCardDetailsInput!
Required input for credit card related information.
is_active_payment_token_enabler - Boolean
Indicates whether details about the shopper's credit/debit card should be tokenized for later usage. Required only if Vault is enabled for the PayPal Payflow Pro payment integration.

Example

Copied to your clipboard
{
  "cc_details": CreditCardDetailsInput,
  "is_active_payment_token_enabler": false
}

PayflowProResponseInput

Input required to complete payment. Applies to Payflow Pro and Payments Pro payment methods.

Input Fields

Input FieldDescription
cart_id - String!
The unique ID that identifies the shopper's cart.
paypal_payload - String!
The payload returned from PayPal.

Example

Copied to your clipboard
{
  "cart_id": "xyz789",
  "paypal_payload": "xyz789"
}

PayflowProResponseOutput

Fields

Field NameDescription
cart - Cart!
The cart with the updated selected payment method.

Example

Copied to your clipboard
{"cart": Cart}

PayflowProTokenInput

Contains input required to fetch payment token information for the Payflow Pro and Payments Pro payment methods.

Input Fields

Input FieldDescription
cart_id - String!
The unique ID that identifies the shopper's cart.
urls - PayflowProUrlInput!
A set of relative URLs that PayPal uses for callback.

Example

Copied to your clipboard
{
  "cart_id": "xyz789",
  "urls": PayflowProUrlInput
}

PayflowProUrlInput

Contains a set of relative URLs that PayPal uses in response to various actions during the authorization process. Magento prepends the base URL to this value to create a full URL. For example, if the full URL is https://www.example.com/path/to/page.html, the relative URL is path/to/page.html. Use this input for the Payflow Pro and Payment Pro payment methods.

Input Fields

Input FieldDescription
cancel_url - String!
The relative URL of the page that PayPal redirects to when the buyer cancels the transaction in order to choose a different payment method. If the full URL to this page is https://www.example.com/paypal/action/cancel.html, the relative URL is paypal/action/cancel.html.
error_url - String!
The relative URL of the transaction error page that PayPal redirects to upon payment error. If the full URL to this page is https://www.example.com/paypal/action/error.html, the relative URL is paypal/action/error.html.
return_url - String!
The relative URL of the final confirmation page that PayPal redirects to upon payment success. If the full URL to this page is https://www.example.com/paypal/action/return.html, the relative URL is paypal/action/return.html.

Example

Copied to your clipboard
{
  "cancel_url": "abc123",
  "error_url": "abc123",
  "return_url": "abc123"
}

PaymentConfigItem

Contains payment fields that are common to all types of payment methods.

Fields

Field NameDescription
code - String
The payment method code as defined in the payment gateway
is_visible - Boolean
Indicates whether the payment method is displayed
payment_intent - String
Defines the payment intent (Authorize or Capture
sdk_params - [SDKParams]
The PayPal parameters required to load the JS SDK
sort_order - String
The relative order the payment method is displayed on the checkout page
title - String
The name displayed for the payment method

Possible Types

PaymentConfigItem Types
HostedFieldsConfig
SmartButtonsConfig
ApplePayConfig
GooglePayConfig
FastlaneConfig

Example

Copied to your clipboard
{
  "code": "xyz789",
  "is_visible": true,
  "payment_intent": "xyz789",
  "sdk_params": [SDKParams],
  "sort_order": "abc123",
  "title": "abc123"
}

PaymentConfigOutput

Retrieves the payment configuration for a given location

Fields

Field NameDescription
apple_pay - ApplePayConfig
ApplePay payment method configuration
fastlane - FastlaneConfig
Fastlane payment method configuration
google_pay - GooglePayConfig
GooglePay payment method configuration
hosted_fields - HostedFieldsConfig
Hosted fields payment method configuration
smart_buttons - SmartButtonsConfig
Smart Buttons payment method configuration

Example

Copied to your clipboard
{
  "apple_pay": ApplePayConfig,
  "fastlane": FastlaneConfig,
  "google_pay": GooglePayConfig,
  "hosted_fields": HostedFieldsConfig,
  "smart_buttons": SmartButtonsConfig
}

PaymentLocation

Defines the origin location for that payment request

Values

Enum ValueDescription
PRODUCT_DETAIL
MINICART
CART
CHECKOUT
START_OF_CHECKOUT
ADMIN

Example

Copied to your clipboard
""PRODUCT_DETAIL""

PaymentMethodInput

Defines the payment method.

Input Fields

Input FieldDescription
braintree - BraintreeInput
braintree_ach_direct_debit - BraintreeInput
braintree_ach_direct_debit_vault - BraintreeVaultInput
braintree_applepay_vault - BraintreeVaultInput
braintree_cc_vault - BraintreeCcVaultInput
braintree_googlepay_vault - BraintreeVaultInput
braintree_paypal - BraintreeInput
braintree_paypal_vault - BraintreeVaultInput
code - String!
The internal name for the payment method.
hosted_pro - HostedProInput
Required input for PayPal Hosted pro payments.
payflow_express - PayflowExpressInput
Required input for Payflow Express Checkout payments.
payflow_link - PayflowLinkInput
Required input for PayPal Payflow Link and Payments Advanced payments.
payflowpro - PayflowProInput
Required input for PayPal Payflow Pro and Payment Pro payments.
payflowpro_cc_vault - VaultTokenInput
Required input for PayPal Payflow Pro vault payments.
payment_services_paypal_apple_pay - ApplePayMethodInput
Required input for Apple Pay button
payment_services_paypal_fastlane - FastlaneMethodInput
Required input for fastlane
payment_services_paypal_google_pay - GooglePayMethodInput
Required input for Google Pay button
payment_services_paypal_hosted_fields - HostedFieldsInput
Required input for Hosted Fields
payment_services_paypal_smart_buttons - SmartButtonMethodInput
Required input for Smart buttons
payment_services_paypal_vault - VaultMethodInput
Required input for vault
paypal_express - PaypalExpressInput
Required input for Express Checkout and Payments Standard payments.
purchase_order_number - String
The purchase order number. Optional for most payment methods.

Example

Copied to your clipboard
{
  "braintree": BraintreeInput,
  "braintree_ach_direct_debit": BraintreeInput,
  "braintree_ach_direct_debit_vault": BraintreeVaultInput,
  "braintree_applepay_vault": BraintreeVaultInput,
  "braintree_cc_vault": BraintreeCcVaultInput,
  "braintree_googlepay_vault": BraintreeVaultInput,
  "braintree_paypal": BraintreeInput,
  "braintree_paypal_vault": BraintreeVaultInput,
  "code": "abc123",
  "hosted_pro": HostedProInput,
  "payflow_express": PayflowExpressInput,
  "payflow_link": PayflowLinkInput,
  "payflowpro": PayflowProInput,
  "payflowpro_cc_vault": VaultTokenInput,
  "payment_services_paypal_apple_pay": ApplePayMethodInput,
  "payment_services_paypal_fastlane": FastlaneMethodInput,
  "payment_services_paypal_google_pay": GooglePayMethodInput,
  "payment_services_paypal_hosted_fields": HostedFieldsInput,
  "payment_services_paypal_smart_buttons": SmartButtonMethodInput,
  "payment_services_paypal_vault": VaultMethodInput,
  "paypal_express": PaypalExpressInput,
  "purchase_order_number": "xyz789"
}

PaymentOrderOutput

Contains the payment order details

Fields

Field NameDescription
id - String
PayPal order ID
mp_order_id - String
The order ID generated by Payment Services
payment_source_details - PaymentSourceDetails
Details about the card used on the order
status - String
The status of the payment order

Example

Copied to your clipboard
{
  "id": "abc123",
  "mp_order_id": "xyz789",
  "payment_source_details": PaymentSourceDetails,
  "status": "xyz789"
}

PaymentSDKParamsItem

Fields

Field NameDescription
code - String
The payment method code used in the order
params - [SDKParams]
The payment SDK parameters

Example

Copied to your clipboard
{
  "code": "xyz789",
  "params": [SDKParams]
}

PaymentSourceDetails

Fields

Field NameDescription
card - Card
Details about the card used on the order

Example

Copied to your clipboard
{"card": Card}

PaymentSourceInput

The payment source information

Input Fields

Input FieldDescription
card - CardPaymentSourceInput!
The card payment source information

Example

Copied to your clipboard
{"card": CardPaymentSourceInput}

PaymentSourceOutput

The payment source information

Fields

Field NameDescription
card - CardPaymentSourceOutput!
The card payment source information

Example

Copied to your clipboard
{"card": CardPaymentSourceOutput}

PaymentToken

The stored payment method available to the customer.

Fields

Field NameDescription
details - String
A description of the stored account details.
payment_method_code - String!
The payment method code associated with the token.
public_hash - String!
The public hash of the token.
type - PaymentTokenTypeEnum!
Specifies the payment token type.

Example

Copied to your clipboard
{
  "details": "xyz789",
  "payment_method_code": "abc123",
  "public_hash": "abc123",
  "type": "card"
}

PaymentTokenTypeEnum

The list of available payment token types.

Values

Enum ValueDescription
card
phpcs:ignore Magento2.GraphQL.ValidArgumentName
account
phpcs:ignore Magento2.GraphQL.ValidArgumentName

Example

Copied to your clipboard
""card""

PaypalExpressInput

Contains required input for Express Checkout and Payments Standard payments.

Input Fields

Input FieldDescription
payer_id - String!
The unique ID of the PayPal user.
token - String!
The token returned by the `createPaypalExpressToken` mutation.

Example

Copied to your clipboard
{
  "payer_id": "xyz789",
  "token": "xyz789"
}

PaypalExpressTokenInput

Defines the attributes required to receive a payment token for Express Checkout and Payments Standard payment methods.

Input Fields

Input FieldDescription
cart_id - String!
The unique ID that identifies the customer's cart.
code - String!
The payment method code.
express_button - Boolean
Indicates whether the buyer selected the quick checkout button. The default value is false.
urls - PaypalExpressUrlsInput!
A set of relative URLs that PayPal uses in response to various actions during the authorization process.
use_paypal_credit - Boolean
Indicates whether the buyer clicked the PayPal credit button. The default value is false.

Example

Copied to your clipboard
{
  "cart_id": "xyz789",
  "code": "xyz789",
  "express_button": true,
  "urls": PaypalExpressUrlsInput,
  "use_paypal_credit": false
}

PaypalExpressTokenOutput

Contains the token returned by PayPal and a set of URLs that allow the buyer to authorize payment and adjust checkout details. Applies to Express Checkout and Payments Standard payment methods.

Fields

Field NameDescription
paypal_urls - PaypalExpressUrlList
A set of URLs that allow the buyer to authorize payment and adjust checkout details.
token - String
The token returned by PayPal.

Example

Copied to your clipboard
{
  "paypal_urls": PaypalExpressUrlList,
  "token": "abc123"
}

PaypalExpressUrlList

Contains a set of URLs that allow the buyer to authorize payment and adjust checkout details for Express Checkout and Payments Standard transactions.

Fields

Field NameDescription
edit - String
The PayPal URL that allows the buyer to edit their checkout details.
start - String
The URL to the PayPal login page.

Example

Copied to your clipboard
{
  "edit": "abc123",
  "start": "abc123"
}

PaypalExpressUrlsInput

Contains a set of relative URLs that PayPal uses in response to various actions during the authorization process. Magento prepends the base URL to this value to create a full URL. For example, if the full URL is https://www.example.com/path/to/page.html, the relative URL is path/to/page.html. Use this input for Express Checkout and Payments Standard payment methods.

Input Fields

Input FieldDescription
cancel_url - String!
The relative URL of the page that PayPal redirects to when the buyer cancels the transaction in order to choose a different payment method. If the full URL to this page is https://www.example.com/paypal/action/cancel.html, the relative URL is paypal/action/cancel.html.
pending_url - String
The relative URL of the page that PayPal redirects to when the payment has been put on hold for additional review. This condition mostly applies to ACH transactions, and is not applicable to most PayPal solutions. If the full URL to this page is https://www.example.com/paypal/action/success_pending.html, the relative URL is paypal/action/success_pending.html.
return_url - String!
The relative URL of the final confirmation page that PayPal redirects to upon payment success. If the full URL to this page is https://www.example.com/paypal/action/return.html, the relative URL is paypal/action/return.html.
success_url - String
The relative URL of the order confirmation page that PayPal redirects to when the payment is successful and additional confirmation is not needed. Not applicable to most PayPal solutions. If the full URL to this page is https://www.example.com/paypal/action/success.html, the relative URL is paypal/action/success.html.

Example

Copied to your clipboard
{
  "cancel_url": "xyz789",
  "pending_url": "abc123",
  "return_url": "abc123",
  "success_url": "xyz789"
}

PhysicalProductInterface

Contains attributes specific to tangible products.

Fields

Field NameDescription
weight - Float
The weight of the item, in units defined by the store.

Possible Types

PhysicalProductInterface Types
SimpleProduct
ConfigurableProduct
BundleProduct
GiftCardProduct
GroupedProduct

Example

Copied to your clipboard
{"weight": 123.45}

PickupLocation

Defines Pickup Location information.

Fields

Field NameDescription
city - String
contact_name - String
country_id - String
description - String
email - String
fax - String
latitude - Float
longitude - Float
name - String
phone - String
pickup_location_code - String
postcode - String
region - String
region_id - Int
street - String

Example

Copied to your clipboard
{
  "city": "xyz789",
  "contact_name": "xyz789",
  "country_id": "xyz789",
  "description": "abc123",
  "email": "xyz789",
  "fax": "xyz789",
  "latitude": 987.65,
  "longitude": 123.45,
  "name": "xyz789",
  "phone": "xyz789",
  "pickup_location_code": "xyz789",
  "postcode": "abc123",
  "region": "abc123",
  "region_id": 123,
  "street": "xyz789"
}

PickupLocationFilterInput

PickupLocationFilterInput defines the list of attributes and filters for the search.

Input Fields

Input FieldDescription
city - FilterTypeInput
Filter by city.
country_id - FilterTypeInput
Filter by country.
name - FilterTypeInput
Filter by pickup location name.
pickup_location_code - FilterTypeInput
Filter by pickup location code.
postcode - FilterTypeInput
Filter by postcode.
region - FilterTypeInput
Filter by region.
region_id - FilterTypeInput
Filter by region id.
street - FilterTypeInput
Filter by street.

Example

Copied to your clipboard
{
  "city": FilterTypeInput,
  "country_id": FilterTypeInput,
  "name": FilterTypeInput,
  "pickup_location_code": FilterTypeInput,
  "postcode": FilterTypeInput,
  "region": FilterTypeInput,
  "region_id": FilterTypeInput,
  "street": FilterTypeInput
}

PickupLocationSortInput

PickupLocationSortInput specifies attribute to use for sorting search results and indicates whether the results are sorted in ascending or descending order.

Input Fields

Input FieldDescription
city - SortEnum
City where pickup location is placed.
contact_name - SortEnum
Name of the contact person.
country_id - SortEnum
Id of the country in two letters.
description - SortEnum
Description of the pickup location.
distance - SortEnum
Distance to the address, requested by distance filter. Applicable only with distance filter. If distance sort order is present, all other sort orders will be ignored.
email - SortEnum
Contact email of the pickup location.
fax - SortEnum
Contact fax of the pickup location.
latitude - SortEnum
Geographic latitude where pickup location is placed.
longitude - SortEnum
Geographic longitude where pickup location is placed.
name - SortEnum
The pickup location name. Customer use this to identify the pickup location.
phone - SortEnum
Contact phone number of the pickup location.
pickup_location_code - SortEnum
A code assigned to pickup location to identify the source.
postcode - SortEnum
Postcode where pickup location is placed.
region - SortEnum
Name of the region.
region_id - SortEnum
Id of the region.
street - SortEnum
Street where pickup location is placed.

Example

Copied to your clipboard
{
  "city": "ASC",
  "contact_name": "ASC",
  "country_id": "ASC",
  "description": "ASC",
  "distance": "ASC",
  "email": "ASC",
  "fax": "ASC",
  "latitude": "ASC",
  "longitude": "ASC",
  "name": "ASC",
  "phone": "ASC",
  "pickup_location_code": "ASC",
  "postcode": "ASC",
  "region": "ASC",
  "region_id": "ASC",
  "street": "ASC"
}

PickupLocations

Top level object returned in a pickup locations search.

Fields

Field NameDescription
items - [PickupLocation]
An array of pickup locations that match the specific search request.
page_info - SearchResultPageInfo
An object that includes the page_info and currentPage values specified in the query.
total_count - Int
The number of products returned.

Example

Copied to your clipboard
{
  "items": [PickupLocation],
  "page_info": SearchResultPageInfo,
  "total_count": 123
}

PlaceNegotiableQuoteOrderInput

Specifies the negotiable quote to convert to an order.

Input Fields

Input FieldDescription
quote_uid - ID!
The unique ID of a `NegotiableQuote` object.

Example

Copied to your clipboard
{"quote_uid": "4"}

PlaceNegotiableQuoteOrderOutput

An output object that returns the generated order.

Fields

Field NameDescription
order - Order!
Contains the generated order number.

Example

Copied to your clipboard
{"order": Order}

PlaceOrderError

An error encountered while placing an order.

Fields

Field NameDescription
code - PlaceOrderErrorCodes!
An error code that is specific to place order.
message - String!
A localized error message.

Example

Copied to your clipboard
{
  "code": "CART_NOT_FOUND",
  "message": "xyz789"
}

PlaceOrderErrorCodes

Values

Enum ValueDescription
CART_NOT_FOUND
CART_NOT_ACTIVE
GUEST_EMAIL_MISSING
UNABLE_TO_PLACE_ORDER
UNDEFINED

Example

Copied to your clipboard
""CART_NOT_FOUND""

PlaceOrderForPurchaseOrderInput

Specifies the purchase order to convert to an order.

Input Fields

Input FieldDescription
purchase_order_uid - ID!
The unique ID of a purchase order.

Example

Copied to your clipboard
{"purchase_order_uid": "4"}

PlaceOrderForPurchaseOrderOutput

Contains the results of the request to place an order.

Fields

Field NameDescription
order - CustomerOrder!
Placed order.

Example

Copied to your clipboard
{"order": CustomerOrder}

PlaceOrderInput

Specifies the quote to be converted to an order.

Input Fields

Input FieldDescription
cart_id - String!
The unique ID of a `Cart` object.

Example

Copied to your clipboard
{"cart_id": "xyz789"}

PlaceOrderOutput

Contains the results of the request to place an order.

Fields

Field NameDescription
errors - [PlaceOrderError]
An array of place order errors.
order - Order
The ID of the order. (Deprecated: Use `orderV2` instead.)
orderV2 - CustomerOrder
Full order information.

Example

Copied to your clipboard
{
  "errors": [PlaceOrderError],
  "order": Order,
  "orderV2": CustomerOrder
}

PlacePurchaseOrderInput

Specifies the quote to be converted to a purchase order.

Input Fields

Input FieldDescription
cart_id - String!
The unique ID of a `Cart` object.

Example

Copied to your clipboard
{"cart_id": "abc123"}

PlacePurchaseOrderOutput

Contains the results of the request to place a purchase order.

Fields

Field NameDescription
purchase_order - PurchaseOrder!
Placed purchase order.

Example

Copied to your clipboard
{"purchase_order": PurchaseOrder}

Price

Deprecated. Use ProductPrice instead. Defines the price of a product as well as any tax-related adjustments.

Fields

Field NameDescription
adjustments - [PriceAdjustment]
An array that provides information about tax, weee, or weee_tax adjustments. (Deprecated: Use `ProductPrice` instead.)
amount - Money
The price of a product plus a three-letter currency code. (Deprecated: Use `ProductPrice` instead.)

Example

Copied to your clipboard
{
  "adjustments": [PriceAdjustment],
  "amount": Money
}

PriceAdjustment

Deprecated. Taxes will be included or excluded in the price. Defines the amount of money to apply as an adjustment, the type of adjustment to apply, and whether the item is included or excluded from the adjustment.

Fields

Field NameDescription
amount - Money
The amount of the price adjustment and its currency code.
code - PriceAdjustmentCodesEnum
Indicates whether the adjustment involves tax, weee, or weee_tax. (Deprecated: `PriceAdjustment` is deprecated.)
description - PriceAdjustmentDescriptionEnum
Indicates whether the entity described by the code attribute is included or excluded from the adjustment. (Deprecated: `PriceAdjustment` is deprecated.)

Example

Copied to your clipboard
{
  "amount": Money,
  "code": "TAX",
  "description": "INCLUDED"
}

PriceAdjustmentCodesEnum

PriceAdjustment.code is deprecated.

Values

Enum ValueDescription
TAX
(Deprecated: `PriceAdjustmentCodesEnum` is deprecated. Tax is included or excluded in the price. Tax is not shown separately in Catalog.)
WEEE
(Deprecated: WEEE code is deprecated. Use `fixed_product_taxes.label` instead.)
WEEE_TAX
(Deprecated: Use `fixed_product_taxes` instead. Tax is included or excluded in price. The tax is not shown separtely in Catalog.)

Example

Copied to your clipboard
""TAX""

PriceAdjustmentDescriptionEnum

PriceAdjustmentDescriptionEnum is deprecated. States whether a price adjustment is included or excluded.

Values

Enum ValueDescription
INCLUDED
EXCLUDED

Example

Copied to your clipboard
""INCLUDED""

PriceDetails

Can be used to retrieve the main price details in case of bundle product

Fields

Field NameDescription
discount_percentage - Float
The percentage of discount applied to the main product price
main_final_price - Float
The final price after applying the discount to the main product
main_price - Float
The regular price of the main product

Example

Copied to your clipboard
{
  "discount_percentage": 123.45,
  "main_final_price": 987.65,
  "main_price": 987.65
}

PriceRange

Contains the price range for a product. If the product has a single price, the minimum and maximum price will be the same.

Fields

Field NameDescription
maximum_price - ProductPrice
The highest possible price for the product.
minimum_price - ProductPrice!
The lowest possible price for the product.

Example

Copied to your clipboard
{
  "maximum_price": ProductPrice,
  "minimum_price": ProductPrice
}

PriceTypeEnum

Defines the price type.

Values

Enum ValueDescription
FIXED
PERCENT
DYNAMIC

Example

Copied to your clipboard
""FIXED""

PriceViewEnum

Defines whether a bundle product's price is displayed as the lowest possible value or as a range.

Values

Enum ValueDescription
PRICE_RANGE
AS_LOW_AS

Example

Copied to your clipboard
""PRICE_RANGE""

ProductAttribute

Contains a product attribute code and value.

Fields

Field NameDescription
code - String!
The unique identifier for a product attribute code.
value - String!
The display value of the attribute.

Example

Copied to your clipboard
{
  "code": "abc123",
  "value": "xyz789"
}

ProductAttributeFilterInput

Defines the filters to be used in the search. A filter contains at least one attribute, a comparison operator, and the value that is being searched for.

Input Fields

Input FieldDescription
category_id - FilterEqualTypeInput
Deprecated: use `category_uid` to filter product by category ID.
category_uid - FilterEqualTypeInput
Filter product by the unique ID for a `CategoryInterface` object.
category_url_path - FilterEqualTypeInput
Filter product by category URL path.
description - FilterMatchTypeInput
Attribute label: Description
name - FilterMatchTypeInput
Attribute label: Product Name
price - FilterRangeTypeInput
Attribute label: Price
short_description - FilterMatchTypeInput
Attribute label: Short Description
sku - FilterEqualTypeInput
Attribute label: SKU
url_key - FilterEqualTypeInput
The part of the URL that identifies the product

Example

Copied to your clipboard
{
  "category_id": FilterEqualTypeInput,
  "category_uid": FilterEqualTypeInput,
  "category_url_path": FilterEqualTypeInput,
  "description": FilterMatchTypeInput,
  "name": FilterMatchTypeInput,
  "price": FilterRangeTypeInput,
  "short_description": FilterMatchTypeInput,
  "sku": FilterEqualTypeInput,
  "url_key": FilterEqualTypeInput
}

ProductAttributeSortInput

Specifies the attribute to use for sorting search results and indicates whether the results are sorted in ascending or descending order. It's possible to sort products using searchable attributes with enabled 'Use in Filter Options' option

Input Fields

Input FieldDescription
name - SortEnum
Attribute label: Product Name
position - SortEnum
Sort by the position assigned to each product.
price - SortEnum
Attribute label: Price
relevance - SortEnum
Sort by the search relevance score (default).

Example

Copied to your clipboard
{"name": "ASC", "position": "ASC", "price": "ASC", "relevance": "ASC"}

ProductCustomAttributes

Product custom attributes

Fields

Field NameDescription
errors - [AttributeMetadataError]!
Errors when retrieving custom attributes metadata.
items - [AttributeValueInterface]!
Requested custom attributes

Example

Copied to your clipboard
{
  "errors": [AttributeMetadataError],
  "items": [AttributeValueInterface]
}

ProductDiscount

Contains the discount applied to a product price.

Fields

Field NameDescription
amount_off - Float
The actual value of the discount.
percent_off - Float
The discount expressed a percentage.

Example

Copied to your clipboard
{"amount_off": 987.65, "percent_off": 123.45}

ProductFilterInput

ProductFilterInput is deprecated, use @ProductAttributeFilterInput instead. ProductFilterInput defines the filters to be used in the search. A filter contains at least one attribute, a comparison operator, and the value that is being searched for.

Input Fields

Input FieldDescription
category_id - FilterTypeInput
The category ID the product belongs to.
country_of_manufacture - FilterTypeInput
The product's country of origin.
created_at - FilterTypeInput
The timestamp indicating when the product was created.
custom_layout - FilterTypeInput
The name of a custom layout.
custom_layout_update - FilterTypeInput
XML code that is applied as a layout update to the product page.
description - FilterTypeInput
Detailed information about the product. The value can include simple HTML tags.
gift_message_available - FilterTypeInput
Indicates whether a gift message is available.
has_options - FilterTypeInput
Indicates whether additional attributes have been created for the product.
image - FilterTypeInput
The relative path to the main image on the product page.
image_label - FilterTypeInput
The label assigned to a product image.
is_returnable - FilterTypeInput
Indicates whether the product can be returned.
manufacturer - FilterTypeInput
A number representing the product's manufacturer.
max_price - FilterTypeInput
The numeric maximal price of the product. Do not include the currency code.
meta_description - FilterTypeInput
A brief overview of the product for search results listings, maximum 255 characters.
meta_keyword - FilterTypeInput
A comma-separated list of keywords that are visible only to search engines.
meta_title - FilterTypeInput
A string that is displayed in the title bar and tab of the browser and in search results lists.
min_price - FilterTypeInput
The numeric minimal price of the product. Do not include the currency code.
name - FilterTypeInput
The product name. Customers use this name to identify the product.
news_from_date - FilterTypeInput
The beginning date for new product listings, and determines if the product is featured as a new product.
news_to_date - FilterTypeInput
The end date for new product listings.
options_container - FilterTypeInput
If the product has multiple options, determines where they appear on the product page.
or - ProductFilterInput
The keyword required to perform a logical OR comparison.
price - FilterTypeInput
The price of an item.
required_options - FilterTypeInput
Indicates whether the product has required options.
short_description - FilterTypeInput
A short description of the product. Its use depends on the theme.
sku - FilterTypeInput
A number or code assigned to a product to identify the product, options, price, and manufacturer.
small_image - FilterTypeInput
The relative path to the small image, which is used on catalog pages.
small_image_label - FilterTypeInput
The label assigned to a product's small image.
special_from_date - FilterTypeInput
The beginning date that a product has a special price.
special_price - FilterTypeInput
The discounted price of the product. Do not include the currency code.
special_to_date - FilterTypeInput
The end date that a product has a special price.
swatch_image - FilterTypeInput
The file name of a swatch image.
thumbnail - FilterTypeInput
The relative path to the product's thumbnail image.
thumbnail_label - FilterTypeInput
The label assigned to a product's thumbnail image.
tier_price - FilterTypeInput
The price when tier pricing is in effect and the items purchased threshold has been reached.
updated_at - FilterTypeInput
The timestamp indicating when the product was updated.
url_key - FilterTypeInput
The part of the URL that identifies the product
url_path - FilterTypeInput
weight - FilterTypeInput
The weight of the item, in units defined by the store.

Example

Copied to your clipboard
{
  "category_id": FilterTypeInput,
  "country_of_manufacture": FilterTypeInput,
  "created_at": FilterTypeInput,
  "custom_layout": FilterTypeInput,
  "custom_layout_update": FilterTypeInput,
  "description": FilterTypeInput,
  "gift_message_available": FilterTypeInput,
  "has_options": FilterTypeInput,
  "image": FilterTypeInput,
  "image_label": FilterTypeInput,
  "is_returnable": FilterTypeInput,
  "manufacturer": FilterTypeInput,
  "max_price": FilterTypeInput,
  "meta_description": FilterTypeInput,
  "meta_keyword": FilterTypeInput,
  "meta_title": FilterTypeInput,
  "min_price": FilterTypeInput,
  "name": FilterTypeInput,
  "news_from_date": FilterTypeInput,
  "news_to_date": FilterTypeInput,
  "options_container": FilterTypeInput,
  "or": ProductFilterInput,
  "price": FilterTypeInput,
  "required_options": FilterTypeInput,
  "short_description": FilterTypeInput,
  "sku": FilterTypeInput,
  "small_image": FilterTypeInput,
  "small_image_label": FilterTypeInput,
  "special_from_date": FilterTypeInput,
  "special_price": FilterTypeInput,
  "special_to_date": FilterTypeInput,
  "swatch_image": FilterTypeInput,
  "thumbnail": FilterTypeInput,
  "thumbnail_label": FilterTypeInput,
  "tier_price": FilterTypeInput,
  "updated_at": FilterTypeInput,
  "url_key": FilterTypeInput,
  "url_path": FilterTypeInput,
  "weight": FilterTypeInput
}

ProductImage

Contains product image information, including the image URL and label.

Fields

Field NameDescription
disabled - Boolean
Indicates whether the image is hidden from view.
label - String
The label of the product image or video.
position - Int
The media item's position after it has been sorted.
types - [String]
Array of image types. It can have the following values: image, small_image, thumbnail.
url - String
The URL of the product image or video.

Example

Copied to your clipboard
{
  "disabled": true,
  "label": "abc123",
  "position": 987,
  "types": ["xyz789"],
  "url": "abc123"
}

ProductImageThumbnail

Values

Enum ValueDescription
ITSELF
Use thumbnail of product as image.
PARENT
Use thumbnail of product's parent as image.

Example

Copied to your clipboard
""ITSELF""

ProductInfoInput

Product Information used for Pickup Locations search.

Input Fields

Input FieldDescription
sku - String!
Product SKU.

Example

Copied to your clipboard
{"sku": "abc123"}

ProductInterface

Contains fields that are common to all types of products.

Fields

Field NameDescription
attribute_set_id - Int
The attribute set assigned to the product. (Deprecated: The field should not be used on the storefront.)
canonical_url - String
The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.
categories - [CategoryInterface]
The categories assigned to a product.
color - Int
(Deprecated: Use the `custom_attributes` field instead.)
country_of_manufacture - String
The product's country of origin.
created_at - String
Timestamp indicating when the product was created. (Deprecated: The field should not be used on the storefront.)
crosssell_products - [ProductInterface]
An array of cross-sell products.
custom_attributesV2 - ProductCustomAttributes
Product custom attributes.
description - ComplexTextValue
Detailed information about the product. The value can include simple HTML tags.
gift_message_available - Boolean!
Returns a value indicating gift message availability for the product.
gift_wrapping_available - Boolean!
Returns a value indicating gift wrapping availability for the product.
gift_wrapping_price - Money
Returns value and currency indicating gift wrapping price for the product.
id - Int
The ID number assigned to the product. (Deprecated: Use the `uid` field instead.)
image - ProductImage
The relative path to the main image on the product page.
is_returnable - String
Indicates whether the product can be returned.
manufacturer - Int
A number representing the product's manufacturer. (Deprecated: Use the `custom_attributes` field instead.)
max_sale_qty - Float
Maximum Qty Allowed in Shopping Cart
media_gallery - [MediaGalleryInterface]
An array of media gallery objects.
media_gallery_entries - [MediaGalleryEntry]
An array of MediaGalleryEntry objects. (Deprecated: Use `media_gallery` instead.)
meta_description - String
A brief overview of the product for search results listings, maximum 255 characters.
meta_keyword - String
A comma-separated list of keywords that are visible only to search engines.
meta_title - String
A string that is displayed in the title bar and tab of the browser and in search results lists.
min_sale_qty - Float
Minimum Qty Allowed in Shopping Cart
name - String
The product name. Customers use this name to identify the product.
new_from_date - String
The beginning date for new product listings, and determines if the product is featured as a new product.
new_to_date - String
The end date for new product listings.
only_x_left_in_stock - Float
Product stock only x left count
options_container - String
If the product has multiple options, determines where they appear on the product page.
price - ProductPrices
Indicates the price of an item. (Deprecated: Use `price_range` for product price information.)
price_range - PriceRange!
The range of prices for the product
price_tiers - [TierPrice]
An array of `TierPrice` objects.
product_links - [ProductLinksInterface]
An array of `ProductLinks` objects.
quantity - Float
Amount of available stock
rating_summary - Float!
The average of all the ratings given to the product.
related_products - [ProductInterface]
An array of related products.
review_count - Int!
The total count of all the reviews given to the product.
reviews - ProductReviews!
The list of products reviews.
short_description - ComplexTextValue
A short description of the product. Its use depends on the theme.
sku - String
A number or code assigned to a product to identify the product, options, price, and manufacturer.
small_image - ProductImage
The relative path to the small image, which is used on catalog pages.
special_from_date - String
The beginning date that a product has a special price. (Deprecated: The field should not be used on the storefront.)
special_price - Float
The discounted price of the product.
special_to_date - String
The end date for a product with a special price.
staged - Boolean!
Indicates whether the product is staged for a future campaign.
stock_status - ProductStockStatus
Stock status of the product
swatch_image - String
The file name of a swatch image.
thumbnail - ProductImage
The relative path to the product's thumbnail image.
tier_price - Float
The price when tier pricing is in effect and the items purchased threshold has been reached. (Deprecated: Use `price_tiers` for product tier price information.)
tier_prices - [ProductTierPrices]
An array of ProductTierPrices objects. (Deprecated: Use `price_tiers` for product tier price information.)
type_id - String
One of simple, virtual, bundle, downloadable, grouped, or configurable. (Deprecated: Use `__typename` instead.)
uid - ID!
The unique ID for a `ProductInterface` object.
updated_at - String
Timestamp indicating when the product was updated. (Deprecated: The field should not be used on the storefront.)
upsell_products - [ProductInterface]
An array of up-sell products.
url_key - String
The part of the URL that identifies the product
url_path - String
(Deprecated: Use product's `canonical_url` or url rewrites instead)
url_rewrites - [UrlRewrite]
URL rewrites list
url_suffix - String
The part of the product URL that is appended after the url key
websites - [Website]
An array of websites in which the product is available. (Deprecated: The field should not be used on the storefront.)

Possible Types

ProductInterface Types
VirtualProduct
SimpleProduct
ConfigurableProduct
DownloadableProduct
BundleProduct
GiftCardProduct
GroupedProduct

Example

Copied to your clipboard
{
  "attribute_set_id": 123,
  "canonical_url": "xyz789",
  "categories": [CategoryInterface],
  "color": 123,
  "country_of_manufacture": "xyz789",
  "created_at": "xyz789",
  "crosssell_products": [ProductInterface],
  "custom_attributesV2": ProductCustomAttributes,
  "description": ComplexTextValue,
  "gift_message_available": false,
  "gift_wrapping_available": true,
  "gift_wrapping_price": Money,
  "id": 123,
  "image": ProductImage,
  "is_returnable": "xyz789",
  "manufacturer": 123,
  "max_sale_qty": 987.65,
  "media_gallery": [MediaGalleryInterface],
  "media_gallery_entries": [MediaGalleryEntry],
  "meta_description": "abc123",
  "meta_keyword": "abc123",
  "meta_title": "abc123",
  "min_sale_qty": 123.45,
  "name": "abc123",
  "new_from_date": "abc123",
  "new_to_date": "abc123",
  "only_x_left_in_stock": 987.65,
  "options_container": "abc123",
  "price": ProductPrices,
  "price_range": PriceRange,
  "price_tiers": [TierPrice],
  "product_links": [ProductLinksInterface],
  "quantity": 987.65,
  "rating_summary": 987.65,
  "related_products": [ProductInterface],
  "review_count": 123,
  "reviews": ProductReviews,
  "short_description": ComplexTextValue,
  "sku": "xyz789",
  "small_image": ProductImage,
  "special_from_date": "abc123",
  "special_price": 123.45,
  "special_to_date": "xyz789",
  "staged": true,
  "stock_status": "IN_STOCK",
  "swatch_image": "abc123",
  "thumbnail": ProductImage,
  "tier_price": 123.45,
  "tier_prices": [ProductTierPrices],
  "type_id": "abc123",
  "uid": 4,
  "updated_at": "abc123",
  "upsell_products": [ProductInterface],
  "url_key": "xyz789",
  "url_path": "abc123",
  "url_rewrites": [UrlRewrite],
  "url_suffix": "xyz789",
  "websites": [Website]
}

ProductLinks

An implementation of ProductLinksInterface.

Fields

Field NameDescription
link_type - String
One of related, associated, upsell, or crosssell.
linked_product_sku - String
The SKU of the linked product.
linked_product_type - String
The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable).
position - Int
The position within the list of product links.
sku - String
The identifier of the linked product.

Example

Copied to your clipboard
{
  "link_type": "xyz789",
  "linked_product_sku": "abc123",
  "linked_product_type": "abc123",
  "position": 123,
  "sku": "xyz789"
}

ProductLinksInterface

Contains information about linked products, including the link type and product type of each item.

Fields

Field NameDescription
link_type - String
One of related, associated, upsell, or crosssell.
linked_product_sku - String
The SKU of the linked product.
linked_product_type - String
The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable).
position - Int
The position within the list of product links.
sku - String
The identifier of the linked product.

Possible Types

ProductLinksInterface Types
ProductLinks

Example

Copied to your clipboard
{
  "link_type": "abc123",
  "linked_product_sku": "abc123",
  "linked_product_type": "abc123",
  "position": 987,
  "sku": "abc123"
}

ProductMediaGalleryEntriesContent

Contains an image in base64 format and basic information about the image.

Fields

Field NameDescription
base64_encoded_data - String
The image in base64 format.
name - String
The file name of the image.
type - String
The MIME type of the file, such as image/png.

Example

Copied to your clipboard
{
  "base64_encoded_data": "xyz789",
  "name": "abc123",
  "type": "xyz789"
}

ProductMediaGalleryEntriesVideoContent

Contains a link to a video file and basic information about the video.

Fields

Field NameDescription
media_type - String
Must be external-video.
video_description - String
A description of the video.
video_metadata - String
Optional data about the video.
video_provider - String
Describes the video source.
video_title - String
The title of the video.
video_url - String
The URL to the video.

Example

Copied to your clipboard
{
  "media_type": "abc123",
  "video_description": "xyz789",
  "video_metadata": "xyz789",
  "video_provider": "xyz789",
  "video_title": "xyz789",
  "video_url": "xyz789"
}

ProductPrice

Represents a product price.

Fields

Field NameDescription
discount - ProductDiscount
The price discount. Represents the difference between the regular and final price.
final_price - Money!
The final price of the product after applying discounts.
fixed_product_taxes - [FixedProductTax]
An array of the multiple Fixed Product Taxes that can be applied to a product price.
regular_price - Money!
The regular price of the product.

Example

Copied to your clipboard
{
  "discount": ProductDiscount,
  "final_price": Money,
  "fixed_product_taxes": [FixedProductTax],
  "regular_price": Money
}

ProductPrices

Deprecated. Use PriceRange instead. Contains the regular price of an item, as well as its minimum and maximum prices. Only composite products, which include bundle, configurable, and grouped products, can contain a minimum and maximum price.

Fields

Field NameDescription
maximalPrice - Price
The highest possible final price for all the options defined within a composite product. If you are specifying a price range, this would be the `to` value. (Deprecated: Use `PriceRange.maximum_price` instead.)
minimalPrice - Price
The lowest possible final price for all the options defined within a composite product. If you are specifying a price range, this would be the `from` value. (Deprecated: Use `PriceRange.minimum_price` instead.)
regularPrice - Price
The base price of a product. (Deprecated: Use `regular_price` from `PriceRange.minimum_price` or `PriceRange.maximum_price` instead.)

Example

Copied to your clipboard
{
  "maximalPrice": Price,
  "minimalPrice": Price,
  "regularPrice": Price
}

ProductReview

Contains details of a product review.

Fields

Field NameDescription
average_rating - Float!
The average of all ratings for this product.
created_at - String!
The date the review was created.
nickname - String!
The customer's nickname. Defaults to the customer name, if logged in.
product - ProductInterface!
The reviewed product.
ratings_breakdown - [ProductReviewRating]!
An array of ratings by rating category, such as quality, price, and value.
summary - String!
The summary (title) of the review.
text - String!
The review text.

Example

Copied to your clipboard
{
  "average_rating": 123.45,
  "created_at": "xyz789",
  "nickname": "xyz789",
  "product": ProductInterface,
  "ratings_breakdown": [ProductReviewRating],
  "summary": "abc123",
  "text": "abc123"
}

ProductReviewRating

Contains data about a single aspect of a product review.

Fields

Field NameDescription
name - String!
The label assigned to an aspect of a product that is being rated, such as quality or price.
value - String!
The rating value given by customer. By default, possible values range from 1 to 5.

Example

Copied to your clipboard
{
  "name": "xyz789",
  "value": "abc123"
}

ProductReviewRatingInput

Contains the reviewer's rating for a single aspect of a review.

Input Fields

Input FieldDescription
id - String!
An encoded rating ID.
value_id - String!
An encoded rating value ID.

Example

Copied to your clipboard
{
  "id": "xyz789",
  "value_id": "xyz789"
}

ProductReviewRatingMetadata

Contains details about a single aspect of a product review.

Fields

Field NameDescription
id - String!
An encoded rating ID.
name - String!
The label assigned to an aspect of a product that is being rated, such as quality or price.
values - [ProductReviewRatingValueMetadata]!
List of product review ratings sorted by position.

Example

Copied to your clipboard
{
  "id": "xyz789",
  "name": "abc123",
  "values": [ProductReviewRatingValueMetadata]
}

ProductReviewRatingValueMetadata

Contains details about a single value in a product review.

Fields

Field NameDescription
value - String!
A ratings scale, such as the number of stars awarded.
value_id - String!
An encoded rating value ID.

Example

Copied to your clipboard
{
  "value": "xyz789",
  "value_id": "xyz789"
}

ProductReviewRatingsMetadata

Contains an array of metadata about each aspect of a product review.

Fields

Field NameDescription
items - [ProductReviewRatingMetadata]!
An array of product reviews sorted by position.

Example

Copied to your clipboard
{"items": [ProductReviewRatingMetadata]}

ProductReviews

Contains an array of product reviews.

Fields

Field NameDescription
items - [ProductReview]!
An array of product reviews.
page_info - SearchResultPageInfo!
Metadata for pagination rendering.

Example

Copied to your clipboard
{
  "items": [ProductReview],
  "page_info": SearchResultPageInfo
}

ProductStockStatus

This enumeration states whether a product stock status is in stock or out of stock

Values

Enum ValueDescription
IN_STOCK
OUT_OF_STOCK

Example

Copied to your clipboard
""IN_STOCK""

ProductTierPrices

Deprecated. Use TierPrice instead. Defines a tier price, which is a quantity discount offered to a specific customer group.

Fields

Field NameDescription
customer_group_id - String
The ID of the customer group. (Deprecated: Not relevant for the storefront.)
percentage_value - Float
The percentage discount of the item. (Deprecated: Use `TierPrice.discount` instead.)
qty - Float
The number of items that must be purchased to qualify for tier pricing. (Deprecated: Use `TierPrice.quantity` instead.)
value - Float
The price of the fixed price item. (Deprecated: Use `TierPrice.final_price` instead.)
website_id - Float
The ID assigned to the website. (Deprecated: Not relevant for the storefront.)

Example

Copied to your clipboard
{
  "customer_group_id": "xyz789",
  "percentage_value": 987.65,
  "qty": 123.45,
  "value": 987.65,
  "website_id": 987.65
}

ProductVideo

Contains information about a product video.

Fields

Field NameDescription
disabled - Boolean
Indicates whether the image is hidden from view.
label - String
The label of the product image or video.
position - Int
The media item's position after it has been sorted.
types - [String]
Array of image types. It can have the following values: image, small_image, thumbnail.
url - String
The URL of the product image or video.
video_content - ProductMediaGalleryEntriesVideoContent
Contains a `ProductMediaGalleryEntriesVideoContent` object.

Example

Copied to your clipboard
{
  "disabled": false,
  "label": "xyz789",
  "position": 123,
  "types": ["abc123"],
  "url": "abc123",
  "video_content": ProductMediaGalleryEntriesVideoContent
}

Products

Contains the results of a products query.

Fields

Field NameDescription
aggregations - [Aggregation]
A bucket that contains the attribute code and label for each filterable option.
filters - [LayerFilter]
Layered navigation filters array. (Deprecated: Use `aggregations` instead.)
items - [ProductInterface]
An array of products that match the specified search criteria.
page_info - SearchResultPageInfo
An object that includes the page_info and currentPage values specified in the query.
sort_fields - SortFields
An object that includes the default sort field and all available sort fields.
suggestions - [SearchSuggestion]
An array of search suggestions for case when search query have no results.
total_count - Int
The number of products that are marked as visible. By default, in complex products, parent products are visible, but their child products are not.

Example

Copied to your clipboard
{
  "aggregations": [Aggregation],
  "filters": [LayerFilter],
  "items": [ProductInterface],
  "page_info": SearchResultPageInfo,
  "sort_fields": SortFields,
  "suggestions": [SearchSuggestion],
  "total_count": 987
}

PurchaseOrder

Contains details about a purchase order.

Fields

Field NameDescription
approval_flow - [PurchaseOrderRuleApprovalFlow]!
The approval flows for each applied rules.
available_actions - [PurchaseOrderAction]!
Purchase order actions available to the customer. Can be used to display action buttons on the client.
comments - [PurchaseOrderComment]!
The set of comments applied to the purchase order.
created_at - String!
The date the purchase order was created.
created_by - Customer
The company user who created the purchase order.
history_log - [PurchaseOrderHistoryItem]!
The log of the events related to the purchase order.
number - String!
The purchase order number.
order - CustomerOrder
The reference to the order placed based on the purchase order.
quote - Cart
The quote related to the purchase order.
status - PurchaseOrderStatus!
The current status of the purchase order.
uid - ID!
A unique identifier for the purchase order.
updated_at - String!
The date the purchase order was last updated.

Example

Copied to your clipboard
{
  "approval_flow": [PurchaseOrderRuleApprovalFlow],
  "available_actions": ["REJECT"],
  "comments": [PurchaseOrderComment],
  "created_at": "xyz789",
  "created_by": Customer,
  "history_log": [PurchaseOrderHistoryItem],
  "number": "xyz789",
  "order": CustomerOrder,
  "quote": Cart,
  "status": "PENDING",
  "uid": 4,
  "updated_at": "xyz789"
}

PurchaseOrderAction

Values

Enum ValueDescription
REJECT
CANCEL
VALIDATE
APPROVE
PLACE_ORDER

Example

Copied to your clipboard
""REJECT""

PurchaseOrderActionError

Contains details about a failed action.

Fields

Field NameDescription
message - String!
The returned error message.
type - PurchaseOrderErrorType!
The error type.

Example

Copied to your clipboard
{"message": "xyz789", "type": "NOT_FOUND"}

PurchaseOrderApprovalFlowEvent

Contains details about a single event in the approval flow of the purchase order.

Fields

Field NameDescription
message - String
A formatted message.
name - String
The approver name.
role - String
The approver role.
status - PurchaseOrderApprovalFlowItemStatus
The status related to the event.
updated_at - String
The date and time the event was updated.

Example

Copied to your clipboard
{
  "message": "abc123",
  "name": "abc123",
  "role": "xyz789",
  "status": "PENDING",
  "updated_at": "abc123"
}

PurchaseOrderApprovalFlowItemStatus

Values

Enum ValueDescription
PENDING
APPROVED
REJECTED

Example

Copied to your clipboard
""PENDING""

PurchaseOrderApprovalRule

Contains details about a purchase order approval rule.

Fields

Field NameDescription
applies_to_roles - [CompanyRole]!
The name of the user(s) affected by the the purchase order approval rule.
approver_roles - [CompanyRole]!
The name of the user who needs to approve purchase orders that trigger the approval rule.
condition - PurchaseOrderApprovalRuleConditionInterface
Condition which triggers the approval rule.
created_at - String!
The date the purchase order rule was created.
created_by - String!
The name of the user who created the purchase order approval rule.
description - String
Description of the purchase order approval rule.
name - String!
The name of the purchase order approval rule.
status - PurchaseOrderApprovalRuleStatus!
The status of the purchase order approval rule.
uid - ID!
The unique identifier for the purchase order approval rule.
updated_at - String!
The date the purchase order rule was last updated.

Example

Copied to your clipboard
{
  "applies_to_roles": [CompanyRole],
  "approver_roles": [CompanyRole],
  "condition": PurchaseOrderApprovalRuleConditionInterface,
  "created_at": "xyz789",
  "created_by": "xyz789",
  "description": "abc123",
  "name": "xyz789",
  "status": "ENABLED",
  "uid": 4,
  "updated_at": "abc123"
}

PurchaseOrderApprovalRuleConditionAmount

Contains approval rule condition details, including the amount to be evaluated.

Fields

Field NameDescription
amount - Money!
The amount to be be used for evaluation of the approval rule condition.
attribute - PurchaseOrderApprovalRuleType
The type of purchase order approval rule.
operator - PurchaseOrderApprovalRuleConditionOperator
The operator to be used for evaluating the approval rule condition.

Example

Copied to your clipboard
{
  "amount": Money,
  "attribute": "GRAND_TOTAL",
  "operator": "MORE_THAN"
}

PurchaseOrderApprovalRuleConditionInterface

Purchase order rule condition details.

Fields

Field NameDescription
attribute - PurchaseOrderApprovalRuleType
The type of purchase order approval rule.
operator - PurchaseOrderApprovalRuleConditionOperator
The operator to be used for evaluating the approval rule condition.

Possible Types

PurchaseOrderApprovalRuleConditionInterface Types
PurchaseOrderApprovalRuleConditionAmount
PurchaseOrderApprovalRuleConditionQuantity

Example

Copied to your clipboard
{"attribute": "GRAND_TOTAL", "operator": "MORE_THAN"}

PurchaseOrderApprovalRuleConditionOperator

Values

Enum ValueDescription
MORE_THAN
LESS_THAN
MORE_THAN_OR_EQUAL_TO
LESS_THAN_OR_EQUAL_TO

Example

Copied to your clipboard
""MORE_THAN""

PurchaseOrderApprovalRuleConditionQuantity

Contains approval rule condition details, including the quantity to be evaluated.

Fields

Field NameDescription
attribute - PurchaseOrderApprovalRuleType
The type of purchase order approval rule.
operator - PurchaseOrderApprovalRuleConditionOperator
The operator to be used for evaluating the approval rule condition.
quantity - Int
The quantity to be used for evaluation of the approval rule condition.

Example

Copied to your clipboard
{"attribute": "GRAND_TOTAL", "operator": "MORE_THAN", "quantity": 987}

PurchaseOrderApprovalRuleInput

Defines a new purchase order approval rule.

Input Fields

Input FieldDescription
applies_to - [ID]!
A list of company user role IDs to which this purchase order approval rule should be applied. When an empty array is provided, the rule is applied to all user roles in the system, including those created in the future.
approvers - [ID]!
A list of B2B user roles that can approve this purchase order approval rule.
condition - CreatePurchaseOrderApprovalRuleConditionInput!
The condition of the purchase order approval rule.
description - String
A summary of the purpose of the purchase order approval rule.
name - String!
The purchase order approval rule name.
status - PurchaseOrderApprovalRuleStatus!
The status of the purchase order approval rule.

Example

Copied to your clipboard
{
  "applies_to": [4],
  "approvers": ["4"],
  "condition": CreatePurchaseOrderApprovalRuleConditionInput,
  "description": "abc123",
  "name": "xyz789",
  "status": "ENABLED"
}

PurchaseOrderApprovalRuleMetadata

Contains metadata that can be used to render rule edit forms.

Fields

Field NameDescription
available_applies_to - [CompanyRole]!
A list of B2B user roles that the rule can be applied to.
available_condition_currencies - [AvailableCurrency]!
A list of currencies that can be used to create approval rules based on amounts, for example shipping cost rules.
available_requires_approval_from - [CompanyRole]!
A list of B2B user roles that can be specified as approvers for the approval rules.

Example

Copied to your clipboard
{
  "available_applies_to": [CompanyRole],
  "available_condition_currencies": [AvailableCurrency],
  "available_requires_approval_from": [CompanyRole]
}

PurchaseOrderApprovalRuleStatus

Values

Enum ValueDescription
ENABLED
DISABLED

Example

Copied to your clipboard
""ENABLED""

PurchaseOrderApprovalRuleType

Values

Enum ValueDescription
GRAND_TOTAL
SHIPPING_INCL_TAX
NUMBER_OF_SKUS

Example

Copied to your clipboard
""GRAND_TOTAL""

PurchaseOrderApprovalRules

Contains the approval rules that the customer can see.

Fields

Field NameDescription
items - [PurchaseOrderApprovalRule]!
A list of purchase order approval rules visible to the customer.
page_info - SearchResultPageInfo
Result pagination details.
total_count - Int
The total number of purchase order approval rules visible to the customer.

Example

Copied to your clipboard
{
  "items": [PurchaseOrderApprovalRule],
  "page_info": SearchResultPageInfo,
  "total_count": 987
}

PurchaseOrderComment

Contains details about a comment.

Fields

Field NameDescription
author - Customer
The user who left the comment.
created_at - String!
The date and time when the comment was created.
text - String!
The text of the comment.
uid - ID!
A unique identifier of the comment.

Example

Copied to your clipboard
{
  "author": Customer,
  "created_at": "abc123",
  "text": "abc123",
  "uid": 4
}

PurchaseOrderErrorType

Values

Enum ValueDescription
NOT_FOUND
OPERATION_NOT_APPLICABLE
COULD_NOT_SAVE
NOT_VALID_DATA
UNDEFINED

Example

Copied to your clipboard
""NOT_FOUND""

PurchaseOrderHistoryItem

Contains details about a status change.

Fields

Field NameDescription
activity - String!
The activity type of the event.
created_at - String!
The date and time when the event happened.
message - String!
The message representation of the event.
uid - ID!
A unique identifier of the purchase order history item.

Example

Copied to your clipboard
{
  "activity": "xyz789",
  "created_at": "xyz789",
  "message": "abc123",
  "uid": 4
}

PurchaseOrderRuleApprovalFlow

Contains details about approval roles applied to the purchase order and status changes.

Fields

Field NameDescription
events - [PurchaseOrderApprovalFlowEvent]!
The approval flow event related to the rule.
rule_name - String!
The name of the applied rule.

Example

Copied to your clipboard
{
  "events": [PurchaseOrderApprovalFlowEvent],
  "rule_name": "abc123"
}

PurchaseOrderStatus

Values

Enum ValueDescription
PENDING
APPROVAL_REQUIRED
APPROVED
ORDER_IN_PROGRESS
ORDER_PLACED
ORDER_FAILED
REJECTED
CANCELED
APPROVED_PENDING_PAYMENT

Example

Copied to your clipboard
""PENDING""

PurchaseOrders

Contains a list of purchase orders.

Fields

Field NameDescription
items - [PurchaseOrder]!
Purchase orders matching the search criteria.
page_info - SearchResultPageInfo
Page information of search result's current page.
total_count - Int
Total number of purchase orders found matching the search criteria.

Example

Copied to your clipboard
{
  "items": [PurchaseOrder],
  "page_info": SearchResultPageInfo,
  "total_count": 123
}

PurchaseOrdersActionInput

Defines which purchase orders to act on.

Input Fields

Input FieldDescription
purchase_order_uids - [ID]!
An array of purchase order UIDs.

Example

Copied to your clipboard
{"purchase_order_uids": [4]}

PurchaseOrdersActionOutput

Returns a list of updated purchase orders and any error messages.

Fields

Field NameDescription
errors - [PurchaseOrderActionError]!
An array of error messages encountered while performing the operation.
purchase_orders - [PurchaseOrder]!
A list of purchase orders.

Example

Copied to your clipboard
{
  "errors": [PurchaseOrderActionError],
  "purchase_orders": [PurchaseOrder]
}

PurchaseOrdersFilterInput

Defines the criteria to use to filter the list of purchase orders.

Input Fields

Input FieldDescription
company_purchase_orders - Boolean
Include only purchase orders made by subordinate company users.
created_date - FilterRangeTypeInput
Filter by the creation date of the purchase order.
require_my_approval - Boolean
Include only purchase orders that are waiting for the customer’s approval.
status - PurchaseOrderStatus
Filter by the status of the purchase order.

Example

Copied to your clipboard
{
  "company_purchase_orders": false,
  "created_date": FilterRangeTypeInput,
  "require_my_approval": true,
  "status": "PENDING"
}

QuoteItemsSortInput

Specifies the field to use for sorting quote items

Input Fields

Input FieldDescription
field - SortQuoteItemsEnum!
Specifies the quote items field to sort by
order - SortEnum!
Specifies the order of quote items' sorting

Example

Copied to your clipboard
{"field": "ITEM_ID", "order": "ASC"}

QuoteTemplateLineItemNoteInput

Sets quote item note.

Input Fields

Input FieldDescription
item_id - ID!
The unique ID of a `CartLineItem` object.
note - String
The note text to be added.
templateId - ID!
The unique ID of a `NegotiableQuoteTemplate` object.

Example

Copied to your clipboard
{
  "item_id": "4",
  "note": "xyz789",
  "templateId": 4
}

QuoteTemplateNotificationMessage

Contains a notification message for a negotiable quote template.

Fields

Field NameDescription
message - String!
The notification message.
type - String!
The type of notification message.

Example

Copied to your clipboard
{
  "message": "xyz789",
  "type": "xyz789"
}

ReCaptchaConfigOutput

Fields

Field NameDescription
configurations - ReCaptchaConfiguration
Configuration details for reCaptcha type
is_enabled - Boolean!
Indicates whether reCaptcha type is enabled

Example

Copied to your clipboard
{
  "configurations": ReCaptchaConfiguration,
  "is_enabled": false
}

ReCaptchaConfiguration

Contains reCAPTCHA form configuration details.

Fields

Field NameDescription
badge_position - String
The position of the invisible reCAPTCHA badge on each page.
language_code - String
A two-character code that specifies the language that is used for Google reCAPTCHA text and messaging.
minimum_score - Float
The minimum score that identifies a user interaction as a potential risk.
re_captcha_type - ReCaptchaTypeEmum!
technical_failure_message - String!
The message that appears when reCaptcha fails.
theme - String!
Theme to be used to render reCaptcha.
validation_failure_message - String!
The message that appears to the user if validation fails.
website_key - String!
The website key generated when the Google reCAPTCHA account was registered.

Example

Copied to your clipboard
{
  "badge_position": "xyz789",
  "language_code": "xyz789",
  "minimum_score": 987.65,
  "re_captcha_type": "INVISIBLE",
  "technical_failure_message": "abc123",
  "theme": "xyz789",
  "validation_failure_message": "abc123",
  "website_key": "abc123"
}

ReCaptchaConfigurationV3

Contains reCAPTCHA V3-Invisible configuration details.

Fields

Field NameDescription
badge_position - String!
The position of the invisible reCAPTCHA badge on each page.
failure_message - String!
The message that appears to the user if validation fails.
forms - [ReCaptchaFormEnum]!
A list of forms on the storefront that have been configured to use reCAPTCHA V3.
is_enabled - Boolean!
Return whether recaptcha is enabled or not
language_code - String
A two-character code that specifies the language that is used for Google reCAPTCHA text and messaging.
minimum_score - Float!
The minimum score that identifies a user interaction as a potential risk.
theme - String!
Theme to be used to render reCaptcha.
website_key - String!
The website key generated when the Google reCAPTCHA account was registered.

Example

Copied to your clipboard
{
  "badge_position": "xyz789",
  "failure_message": "xyz789",
  "forms": ["PLACE_ORDER"],
  "is_enabled": false,
  "language_code": "xyz789",
  "minimum_score": 987.65,
  "theme": "abc123",
  "website_key": "abc123"
}

ReCaptchaFormEnum

Values

Enum ValueDescription
PLACE_ORDER
CONTACT
CUSTOMER_LOGIN
CUSTOMER_FORGOT_PASSWORD
CUSTOMER_CREATE
CUSTOMER_EDIT
NEWSLETTER
PRODUCT_REVIEW
SENDFRIEND
BRAINTREE
RESEND_CONFIRMATION_EMAIL

Example

Copied to your clipboard
""PLACE_ORDER""

ReCaptchaTypeEmum

Values

Enum ValueDescription
INVISIBLE
RECAPTCHA
RECAPTCHA_V3

Example

Copied to your clipboard
""INVISIBLE""

Region

Fields

Field NameDescription
code - String
The two-letter code for the region, such as TX for Texas.
id - Int
The unique ID for a `Region` object.
name - String
The name of the region, such as Texas.

Example

Copied to your clipboard
{
  "code": "xyz789",
  "id": 123,
  "name": "abc123"
}

RemoveCouponFromCartInput

Specifies the cart from which to remove a coupon.

Input Fields

Input FieldDescription
cart_id - String!
The unique ID of a `Cart` object.

Example

Copied to your clipboard
{"cart_id": "xyz789"}

RemoveCouponFromCartOutput

Contains details about the cart after removing a coupon.

Fields

Field NameDescription
cart - Cart
The cart after removing a coupon.

Example

Copied to your clipboard
{"cart": Cart}

RemoveCouponsFromCartInput

Remove coupons from the cart.

Input Fields

Input FieldDescription
cart_id - String!
The unique ID of a `Cart` object.
coupon_codes - [String]!
An array of coupon codes to be removed from the quote. If coupon_codes is empty all coupons will be removed from the quote.

Example

Copied to your clipboard
{
  "cart_id": "abc123",
  "coupon_codes": ["abc123"]
}

RemoveGiftCardFromCartInput

Defines the input required to run the removeGiftCardFromCart mutation.

Input Fields

Input FieldDescription
cart_id - String!
The unique ID that identifies the customer's cart.
gift_card_code - String!
The gift card code to be removed to the cart.

Example

Copied to your clipboard
{
  "cart_id": "xyz789",
  "gift_card_code": "abc123"
}

RemoveGiftCardFromCartOutput

Defines the possible output for the removeGiftCardFromCart mutation.

Fields

Field NameDescription
cart - Cart!
The contents of the specified shopping cart.

Example

Copied to your clipboard
{"cart": Cart}

RemoveGiftRegistryItemsOutput

Contains the results of a request to remove an item from a gift registry.

Fields

Field NameDescription
gift_registry - GiftRegistry
The gift registry after removing items.

Example

Copied to your clipboard
{"gift_registry": GiftRegistry}

RemoveGiftRegistryOutput

Contains the results of a request to delete a gift registry.

Fields

Field NameDescription
success - Boolean!
Indicates whether the gift registry was successfully deleted.

Example

Copied to your clipboard
{"success": false}

RemoveGiftRegistryRegistrantsOutput

Contains the results of a request to delete a registrant.

Fields

Field NameDescription
gift_registry - GiftRegistry
The gift registry after deleting registrants.

Example

Copied to your clipboard
{"gift_registry": GiftRegistry}

RemoveItemFromCartInput

Specifies which items to remove from the cart.

Input Fields

Input FieldDescription
cart_id - String!
The unique ID of a `Cart` object.
cart_item_id - Int
Deprecated. Use `cart_item_uid` instead.
cart_item_uid - ID
Required field. The unique ID for a `CartItemInterface` object.

Example

Copied to your clipboard
{
  "cart_id": "xyz789",
  "cart_item_id": 123,
  "cart_item_uid": 4
}

RemoveItemFromCartOutput

Contains details about the cart after removing an item.

Fields

Field NameDescription
cart - Cart!
The cart after removing an item.

Example

Copied to your clipboard
{"cart": Cart}

RemoveNegotiableQuoteItemsInput

Defines the items to remove from the specified negotiable quote.

Input Fields

Input FieldDescription
quote_item_uids - [ID]!
An array of IDs indicating which items to remove from the negotiable quote.
quote_uid - ID!
The unique ID of a `NegotiableQuote` object.

Example

Copied to your clipboard
{"quote_item_uids": [4], "quote_uid": "4"}

RemoveNegotiableQuoteItemsOutput

Contains the negotiable quote.

Fields

Field NameDescription
quote - NegotiableQuote
The negotiable quote after removing items.

Example

Copied to your clipboard
{"quote": NegotiableQuote}

RemoveNegotiableQuoteTemplateItemsInput

Defines the items to remove from the specified negotiable quote.

Input Fields

Input FieldDescription
item_uids - [ID]!
An array of IDs indicating which items to remove from the negotiable quote.
template_id - ID!
The unique ID of a `NegotiableQuoteTemplate` object.

Example

Copied to your clipboard
{"item_uids": [4], "template_id": 4}

RemoveProductsFromCompareListInput

Defines which products to remove from a compare list.

Input Fields

Input FieldDescription
products - [ID]!
An array of product IDs to remove from the compare list.
uid - ID!
The unique identifier of the compare list to modify.

Example

Copied to your clipboard
{
  "products": ["4"],
  "uid": "4"
}

RemoveProductsFromWishlistOutput

Contains the customer's wish list and any errors encountered.

Fields

Field NameDescription
user_errors - [WishListUserInputError]!
An array of errors encountered while deleting products from a wish list.
wishlist - Wishlist!
Contains the wish list with after items were successfully deleted.

Example

Copied to your clipboard
{
  "user_errors": [WishListUserInputError],
  "wishlist": Wishlist
}

RemoveReturnTrackingInput

Defines the tracking information to delete.

Input Fields

Input FieldDescription
return_shipping_tracking_uid - ID!
The unique ID for a `ReturnShippingTracking` object.

Example

Copied to your clipboard
{"return_shipping_tracking_uid": "4"}

RemoveReturnTrackingOutput

Contains the response after deleting tracking information.

Fields

Field NameDescription
return - Return
Contains details about the modified return.

Example

Copied to your clipboard
{"return": Return}

RemoveRewardPointsFromCartOutput

Contains the customer cart.

Fields

Field NameDescription
cart - Cart!
The customer cart after reward points are removed.

Example

Copied to your clipboard
{"cart": Cart}

RemoveStoreCreditFromCartInput

Defines the input required to run the removeStoreCreditFromCart mutation.

Input Fields

Input FieldDescription
cart_id - String!
The unique ID that identifies the customer's cart.

Example

Copied to your clipboard
{"cart_id": "xyz789"}

RemoveStoreCreditFromCartOutput

Defines the possible output for the removeStoreCreditFromCart mutation.

Fields

Field NameDescription
cart - Cart!
The contents of the specified shopping cart.

Example

Copied to your clipboard
{"cart": Cart}

RenameNegotiableQuoteInput

Sets new name for a negotiable quote.

Input Fields

Input FieldDescription
quote_comment - String
The reason for the quote name change specified by the buyer.
quote_name - String!
The new quote name the buyer specified to the negotiable quote request.
quote_uid - ID!
The cart ID of the buyer requesting a new negotiable quote.

Example

Copied to your clipboard
{
  "quote_comment": "abc123",
  "quote_name": "abc123",
  "quote_uid": "4"
}

RenameNegotiableQuoteOutput

Contains the updated negotiable quote.

Fields

Field NameDescription
quote - NegotiableQuote
The negotiable quote after updating the name.

Example

Copied to your clipboard
{"quote": NegotiableQuote}

ReorderItemsOutput

Contains the cart and any errors after adding products.

Fields

Field NameDescription
cart - Cart!
Detailed information about the customer's cart.
userInputErrors - [CheckoutUserInputError]!
An array of reordering errors.

Example

Copied to your clipboard
{
  "cart": Cart,
  "userInputErrors": [CheckoutUserInputError]
}

RequestGuestReturnInput

Contains information needed to start a return request.

Input Fields

Input FieldDescription
comment_text - String
Text the buyer entered that describes the reason for the refund request.
contact_email - String
The email address the buyer enters to receive notifications about the status of the return.
items - [RequestReturnItemInput]!
An array of items to be returned.
token - String!
Order token.

Example

Copied to your clipboard
{
  "comment_text": "abc123",
  "contact_email": "xyz789",
  "items": [RequestReturnItemInput],
  "token": "xyz789"
}

RequestNegotiableQuoteInput

Defines properties of a negotiable quote request.

Input Fields

Input FieldDescription
cart_id - ID!
The cart ID of the buyer requesting a new negotiable quote.
comment - NegotiableQuoteCommentInput!
Comments the buyer entered to describe the request.
is_draft - Boolean
Flag indicating if quote is draft or not.
quote_name - String!
The name the buyer assigned to the negotiable quote request.

Example

Copied to your clipboard
{
  "cart_id": 4,
  "comment": NegotiableQuoteCommentInput,
  "is_draft": true,
  "quote_name": "abc123"
}

RequestNegotiableQuoteOutput

Contains the NegotiableQuote object generated when a buyer requests a negotiable quote.

Fields

Field NameDescription
quote - NegotiableQuote
Details about the negotiable quote.

Example

Copied to your clipboard
{"quote": NegotiableQuote}

RequestNegotiableQuoteTemplateInput

Defines properties of a negotiable quote template request.

Input Fields

Input FieldDescription
cart_id - ID!
The cart ID of the quote to create the new negotiable quote template from.

Example

Copied to your clipboard
{"cart_id": "4"}

RequestReturnInput

Contains information needed to start a return request.

Input Fields

Input FieldDescription
comment_text - String
Text the buyer entered that describes the reason for the refund request.
contact_email - String
The email address the buyer enters to receive notifications about the status of the return.
items - [RequestReturnItemInput]!
An array of items to be returned.
order_uid - ID!
The unique ID for a `Order` object.

Example

Copied to your clipboard
{
  "comment_text": "abc123",
  "contact_email": "abc123",
  "items": [RequestReturnItemInput],
  "order_uid": 4
}

RequestReturnItemInput

Contains details about an item to be returned.

Input Fields

Input FieldDescription
entered_custom_attributes - [EnteredCustomAttributeInput]
Details about a custom attribute that was entered.
order_item_uid - ID!
The unique ID for a `OrderItemInterface` object.
quantity_to_return - Float!
The quantity of the item to be returned.
selected_custom_attributes - [SelectedCustomAttributeInput]
An array of selected custom option IDs associated with the item to be returned. For example, the IDs for the selected color and size of a configurable product.

Example

Copied to your clipboard
{
  "entered_custom_attributes": [
    EnteredCustomAttributeInput
  ],
  "order_item_uid": 4,
  "quantity_to_return": 987.65,
  "selected_custom_attributes": [
    SelectedCustomAttributeInput
  ]
}

RequestReturnOutput

Contains the response to a return request.

Fields

Field NameDescription
return - Return
Details about a single return request.
returns - Returns
An array of return requests.

Example

Copied to your clipboard
{
  "return": Return,
  "returns": Returns
}

RequisitionList

Defines the contents of a requisition list.

Fields

Field NameDescription
description - String
Optional text that describes the requisition list.
items - RequistionListItems
An array of products added to the requisition list. (Deprecated: Deprecated. Use requisition_list_items instead. Will be removed in a future release.)
items_count - Int!
The number of items in the list.
name - String!
The requisition list name.
requisition_list_items - RequisitionListItems
An array of products added to the requisition list.
uid - ID!
The unique requisition list ID.
updated_at - String
The time of the last modification of the requisition list.

Example

Copied to your clipboard
{
  "description": "abc123",
  "items": RequistionListItems,
  "items_count": 123,
  "name": "abc123",
  "requisition_list_items": RequisitionListItems,
  "uid": "4",
  "updated_at": "abc123"
}

RequisitionListFilterInput

Defines requisition list filters.

Input Fields

Input FieldDescription
name - FilterMatchTypeInput
Filter by the display name of the requisition list.
uids - FilterEqualTypeInput
Filter requisition lists by one or more requisition list IDs.

Example

Copied to your clipboard
{
  "name": FilterMatchTypeInput,
  "uids": FilterEqualTypeInput
}

RequisitionListItemInterface

The interface for requisition list items.

Fields

Field NameDescription
customizable_options - [SelectedCustomizableOption]!
Selected custom options for an item in the requisition list.
product - ProductInterface!
Details about a requisition list item.
quantity - Float!
The amount added.
uid - ID!
The unique ID for the requisition list item.

Possible Types

RequisitionListItemInterface Types
SimpleRequisitionListItem
VirtualRequisitionListItem
DownloadableRequisitionListItem
BundleRequisitionListItem
ConfigurableRequisitionListItem
GiftCardRequisitionListItem

Example

Copied to your clipboard
{
  "customizable_options": [SelectedCustomizableOption],
  "product": ProductInterface,
  "quantity": 123.45,
  "uid": "4"
}

RequisitionListItems

Contains an array of items added to a requisition list.

Fields

Field NameDescription
items - [RequisitionListItemInterface]!
An array of items in the requisition list.
page_info - SearchResultPageInfo
Pagination metadata.
total_pages - Int!
The number of pages returned.

Example

Copied to your clipboard
{
  "items": [RequisitionListItemInterface],
  "page_info": SearchResultPageInfo,
  "total_pages": 123
}

RequisitionListItemsInput

Defines the items to add.

Input Fields

Input FieldDescription
entered_options - [EnteredOptionInput]
Entered option IDs.
parent_sku - String
For configurable products, the SKU of the parent product.
quantity - Float
The quantity of the product to add.
selected_options - [String]
Selected option IDs.
sku - String!
The product SKU.

Example

Copied to your clipboard
{
  "entered_options": [EnteredOptionInput],
  "parent_sku": "abc123",
  "quantity": 987.65,
  "selected_options": ["abc123"],
  "sku": "abc123"
}

RequisitionLists

Defines customer requisition lists.

Fields

Field NameDescription
items - [RequisitionList]
An array of requisition lists.
page_info - SearchResultPageInfo
Pagination metadata.
total_count - Int
The number of returned requisition lists.

Example

Copied to your clipboard
{
  "items": [RequisitionList],
  "page_info": SearchResultPageInfo,
  "total_count": 123
}

RequistionListItems

Deprecated. Use RequisitionListItems via requisition_list_items. Will be removed in a future release.

Fields

Field NameDescription
items - [RequisitionListItemInterface]!
An array of items in the requisition list.
page_info - SearchResultPageInfo
Pagination metadata.
total_pages - Int!
The number of pages returned.

Example

Copied to your clipboard
{
  "items": [RequisitionListItemInterface],
  "page_info": SearchResultPageInfo,
  "total_pages": 987
}

Return

Contains details about a return.

Fields

Field NameDescription
available_shipping_carriers - [ReturnShippingCarrier]
A list of shipping carriers available for returns.
comments - [ReturnComment]
A list of comments posted for the return request.
created_at - String!
The date the return was requested.
customer - ReturnCustomer!
Data from the customer who created the return request.
items - [ReturnItem]
A list of items being returned.
number - String!
A human-readable return number.
order - CustomerOrder
The order associated with the return.
shipping - ReturnShipping
Shipping information for the return.
status - ReturnStatus
The status of the return request.
uid - ID!
The unique ID for a `Return` object.

Example

Copied to your clipboard
{
  "available_shipping_carriers": [ReturnShippingCarrier],
  "comments": [ReturnComment],
  "created_at": "abc123",
  "customer": ReturnCustomer,
  "items": [ReturnItem],
  "number": "xyz789",
  "order": CustomerOrder,
  "shipping": ReturnShipping,
  "status": "PENDING",
  "uid": "4"
}

ReturnComment

Contains details about a return comment.

Fields

Field NameDescription
author_name - String!
The name or author who posted the comment.
created_at - String!
The date and time the comment was posted.
text - String!
The contents of the comment.
uid - ID!
The unique ID for a `ReturnComment` object.

Example

Copied to your clipboard
{
  "author_name": "abc123",
  "created_at": "xyz789",
  "text": "abc123",
  "uid": 4
}

ReturnCustomAttribute

Contains details about a ReturnCustomerAttribute object.

Fields

Field NameDescription
label - String!
A description of the attribute.
uid - ID!
The unique ID for a `ReturnCustomAttribute` object.
value - String!
A JSON-encoded value of the attribute.

Example

Copied to your clipboard
{
  "label": "xyz789",
  "uid": 4,
  "value": "xyz789"
}

ReturnCustomer

The customer information for the return.

Fields

Field NameDescription
email - String!
The email address of the customer.
firstname - String
The first name of the customer.
lastname - String
The last name of the customer.

Example

Copied to your clipboard
{
  "email": "xyz789",
  "firstname": "xyz789",
  "lastname": "abc123"
}

ReturnItem

Contains details about a product being returned.

Fields

Field NameDescription
custom_attributes - [ReturnCustomAttribute]
Return item custom attributes that are visible on the storefront. (Deprecated: Use custom_attributesV2 instead.)
custom_attributesV2 - [AttributeValueInterface]
Custom attributes that are visible on the storefront.
order_item - OrderItemInterface!
Provides access to the product being returned, including information about selected and entered options.
quantity - Float!
The quantity of the item the merchant authorized to be returned.
request_quantity - Float!
The quantity of the item requested to be returned.
status - ReturnItemStatus!
The return status of the item.
uid - ID!
The unique ID for a `ReturnItem` object.

Example

Copied to your clipboard
{
  "custom_attributes": [ReturnCustomAttribute],
  "custom_attributesV2": [AttributeValueInterface],
  "order_item": OrderItemInterface,
  "quantity": 123.45,
  "request_quantity": 123.45,
  "status": "PENDING",
  "uid": "4"
}

ReturnItemAttributeMetadata

Return Item attribute metadata.

Fields

Field NameDescription
code - ID!
The unique identifier for an attribute code. This value should be in lowercase letters without spaces.
default_value - String
Default attribute value.
entity_type - AttributeEntityTypeEnum!
The type of entity that defines the attribute.
frontend_class - String
The frontend class of the attribute.
frontend_input - AttributeFrontendInputEnum
The frontend input type of the attribute.
input_filter - InputFilterEnum
The template used for the input of the attribute (e.g., 'date').
is_required - Boolean!
Whether the attribute value is required.
is_unique - Boolean!
Whether the attribute value must be unique.
label - String
The label assigned to the attribute.
multiline_count - Int
The number of lines of the attribute value.
options - [CustomAttributeOptionInterface]!
Attribute options.
sort_order - Int
The position of the attribute in the form.
validate_rules - [ValidationRule]
The validation rules of the attribute value.

Example

Copied to your clipboard
{
  "code": 4,
  "default_value": "xyz789",
  "entity_type": "CATALOG_PRODUCT",
  "frontend_class": "xyz789",
  "frontend_input": "BOOLEAN",
  "input_filter": "NONE",
  "is_required": false,
  "is_unique": false,
  "label": "abc123",
  "multiline_count": 123,
  "options": [CustomAttributeOptionInterface],
  "sort_order": 123,
  "validate_rules": [ValidationRule]
}

ReturnItemStatus

Values

Enum ValueDescription
PENDING
AUTHORIZED
RECEIVED
APPROVED
REJECTED
DENIED

Example

Copied to your clipboard
""PENDING""

ReturnShipping

Contains details about the return shipping address.

Fields

Field NameDescription
address - ReturnShippingAddress
The merchant-defined return shipping address.
tracking - [ReturnShippingTracking]
The unique ID for a `ReturnShippingTracking` object. If a single UID is specified, the array contains a single tracking record. Otherwise, array contains all tracking information.

Example

Copied to your clipboard
{
  "address": ReturnShippingAddress,
  "tracking": [ReturnShippingTracking]
}

ReturnShippingAddress

Contains details about the shipping address used for receiving returned items.

Fields

Field NameDescription
city - String!
The city for product returns.
contact_name - String
The merchant's contact person.
country - Country!
An object that defines the country for product returns.
postcode - String!
The postal code for product returns.
region - Region!
An object that defines the state or province for product returns.
street - [String]!
The street address for product returns.
telephone - String
The telephone number for product returns.

Example

Copied to your clipboard
{
  "city": "xyz789",
  "contact_name": "xyz789",
  "country": Country,
  "postcode": "abc123",
  "region": Region,
  "street": ["xyz789"],
  "telephone": "xyz789"
}

ReturnShippingCarrier

Contains details about the carrier on a return.

Fields

Field NameDescription
label - String!
A description of the shipping carrier.
uid - ID!
The unique ID for a `ReturnShippingCarrier` object assigned to the shipping carrier.

Example

Copied to your clipboard
{"label": "xyz789", "uid": 4}

ReturnShippingTracking

Contains shipping and tracking details.

Fields

Field NameDescription
carrier - ReturnShippingCarrier!
Contains details of a shipping carrier.
status - ReturnShippingTrackingStatus
Details about the status of a shipment.
tracking_number - String!
A tracking number assigned by the carrier.
uid - ID!
The unique ID for a `ReturnShippingTracking` object assigned to the tracking item.

Example

Copied to your clipboard
{
  "carrier": ReturnShippingCarrier,
  "status": ReturnShippingTrackingStatus,
  "tracking_number": "abc123",
  "uid": 4
}

ReturnShippingTrackingStatus

Contains the status of a shipment.

Fields

Field NameDescription
text - String!
Text that describes the status.
type - ReturnShippingTrackingStatusType!
Indicates whether the status type is informational or an error.

Example

Copied to your clipboard
{"text": "abc123", "type": "INFORMATION"}

ReturnShippingTrackingStatusType

Values

Enum ValueDescription
INFORMATION
ERROR

Example

Copied to your clipboard
""INFORMATION""

ReturnStatus

Values

Enum ValueDescription
PENDING
UNCONFIRMED
AUTHORIZED
PARTIALLY_AUTHORIZED
RECEIVED
PARTIALLY_RECEIVED
APPROVED
PARTIALLY_APPROVED
REJECTED
PARTIALLY_REJECTED
DENIED
PROCESSED_AND_CLOSED
CLOSED

Example

Copied to your clipboard
""PENDING""

Returns

Contains a list of customer return requests.

Fields

Field NameDescription
items - [Return]
A list of return requests.
page_info - SearchResultPageInfo
Pagination metadata.
total_count - Int
The total number of return requests.

Example

Copied to your clipboard
{
  "items": [Return],
  "page_info": SearchResultPageInfo,
  "total_count": 123
}

RevokeCustomerTokenOutput

Contains the result of a request to revoke a customer token.

Fields

Field NameDescription
result - Boolean!
The result of a request to revoke a customer token.

Example

Copied to your clipboard
{"result": true}

RewardPoints

Contains details about a customer's reward points.

Fields

Field NameDescription
balance - RewardPointsAmount
The current balance of reward points.
balance_history - [RewardPointsBalanceHistoryItem]
The balance history of reward points. If the ability for customers to view the balance history has been disabled in the Admin, this field will be set to null.
exchange_rates - RewardPointsExchangeRates
The current exchange rates for reward points.
subscription_status - RewardPointsSubscriptionStatus
The subscription status of emails related to reward points.

Example

Copied to your clipboard
{
  "balance": RewardPointsAmount,
  "balance_history": [RewardPointsBalanceHistoryItem],
  "exchange_rates": RewardPointsExchangeRates,
  "subscription_status": RewardPointsSubscriptionStatus
}

RewardPointsAmount

Fields

Field NameDescription
money - Money!
The reward points amount in store currency.
points - Float!
The reward points amount in points.

Example

Copied to your clipboard
{"money": Money, "points": 123.45}

RewardPointsBalanceHistoryItem

Contain details about the reward points transaction.

Fields

Field NameDescription
balance - RewardPointsAmount
The award points balance after the completion of the transaction.
change_reason - String!
The reason the balance changed.
date - String!
The date of the transaction.
points_change - Float!
The number of points added or deducted in the transaction.

Example

Copied to your clipboard
{
  "balance": RewardPointsAmount,
  "change_reason": "abc123",
  "date": "abc123",
  "points_change": 123.45
}

RewardPointsExchangeRates

Lists the reward points exchange rates. The values depend on the customer group.

Fields

Field NameDescription
earning - RewardPointsRate
How many points are earned for a given amount spent.
redemption - RewardPointsRate
How many points must be redeemed to get a given amount of currency discount at the checkout.

Example

Copied to your clipboard
{
  "earning": RewardPointsRate,
  "redemption": RewardPointsRate
}

RewardPointsRate

Contains details about customer's reward points rate.

Fields

Field NameDescription
currency_amount - Float!
The money value for the exchange rate. For earnings, this is the amount spent to earn the specified points. For redemption, this is the amount of money the number of points represents.
points - Float!
The number of points for an exchange rate. For earnings, this is the number of points earned. For redemption, this is the number of points needed for redemption.

Example

Copied to your clipboard
{"currency_amount": 123.45, "points": 123.45}

RewardPointsSubscriptionStatus

Indicates whether the customer subscribes to reward points emails.

Fields

Field NameDescription
balance_updates - RewardPointsSubscriptionStatusesEnum!
Indicates whether the customer subscribes to 'Reward points balance updates' emails.
points_expiration_notifications - RewardPointsSubscriptionStatusesEnum!
Indicates whether the customer subscribes to 'Reward points expiration notifications' emails.

Example

Copied to your clipboard
{
  "balance_updates": "SUBSCRIBED",
  "points_expiration_notifications": "SUBSCRIBED"
}

RewardPointsSubscriptionStatusesEnum

Values

Enum ValueDescription
SUBSCRIBED
NOT_SUBSCRIBED

Example

Copied to your clipboard
""SUBSCRIBED""

RoutableInterface

Routable entities serve as the model for a rendered page.

Fields

Field NameDescription
redirect_code - Int!
Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.
relative_url - String
The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.
type - UrlRewriteEntityTypeEnum
One of PRODUCT, CATEGORY, or CMS_PAGE.

Possible Types

RoutableInterface Types
CmsPage
CategoryTree
VirtualProduct
SimpleProduct
RoutableUrl
ConfigurableProduct
DownloadableProduct
BundleProduct
GiftCardProduct
GroupedProduct

Example

Copied to your clipboard
{
  "redirect_code": 123,
  "relative_url": "abc123",
  "type": "CMS_PAGE"
}

RoutableUrl

Default implementation of RoutableInterface. This type is returned when the URL is not linked to an entity.

Fields

Field NameDescription
redirect_code - Int!
Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.
relative_url - String
The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.
type - UrlRewriteEntityTypeEnum
One of PRODUCT, CATEGORY, or CMS_PAGE.

Example

Copied to your clipboard
{
  "redirect_code": 987,
  "relative_url": "xyz789",
  "type": "CMS_PAGE"
}

SDKParams

Defines the name and value of a SDK parameter

Fields

Field NameDescription
name - String
The name of the SDK parameter
value - String
The value of the SDK parameter

Example

Copied to your clipboard
{
  "name": "xyz789",
  "value": "abc123"
}

SalesCommentItem

Contains details about a comment.

Fields

Field NameDescription
message - String!
The text of the message.
timestamp - String!
The timestamp of the comment.

Example

Copied to your clipboard
{
  "message": "xyz789",
  "timestamp": "abc123"
}

ScopeTypeEnum

This enumeration defines the scope type for customer orders.

Values

Enum ValueDescription
GLOBAL
WEBSITE
STORE

Example

Copied to your clipboard
""GLOBAL""

SearchResultPageInfo

Provides navigation for the query response.

Fields

Field NameDescription
current_page - Int
The specific page to return.
page_size - Int
The maximum number of items to return per page of results.
total_pages - Int
The total number of pages in the response.

Example

Copied to your clipboard
{"current_page": 987, "page_size": 123, "total_pages": 123}

SearchSuggestion

A string that contains search suggestion

Fields

Field NameDescription
search - String!
The search suggestion of existing product.

Example

Copied to your clipboard
{"search": "xyz789"}

SelectedBundleOption

Contains details about a selected bundle option.

Fields

Field NameDescription
id - Int!
(Deprecated: Use `uid` instead)
label - String!
The display name of the selected bundle product option.
type - String!
The type of selected bundle product option.
uid - ID!
The unique ID for a `SelectedBundleOption` object
values - [SelectedBundleOptionValue]!
An array of selected bundle option values.

Example

Copied to your clipboard
{
  "id": 987,
  "label": "abc123",
  "type": "xyz789",
  "uid": 4,
  "values": [SelectedBundleOptionValue]
}

SelectedBundleOptionValue

Contains details about a value for a selected bundle option.

Fields

Field NameDescription
id - Int!
Use `uid` instead
label - String!
The display name of the value for the selected bundle product option.
original_price - Money!
The original price of the value for the selected bundle product option.
price - Float!
The price of the value for the selected bundle product option. (Deprecated: Use priceV2 instead.)
priceV2 - Money!
The price of the value for the selected bundle product option.
quantity - Float!
The quantity of the value for the selected bundle product option.
uid - ID!
The unique ID for a `SelectedBundleOptionValue` object

Example

Copied to your clipboard
{
  "id": 987,
  "label": "abc123",
  "original_price": Money,
  "price": 987.65,
  "priceV2": Money,
  "quantity": 123.45,
  "uid": 4
}

SelectedConfigurableOption

Contains details about a selected configurable option.

Fields

Field NameDescription
configurable_product_option_uid - ID!
The unique ID for a `ConfigurableProductOptions` object.
configurable_product_option_value_uid - ID!
The unique ID for a `ConfigurableProductOptionsValues` object.
id - Int!
(Deprecated: Use `SelectedConfigurableOption.configurable_product_option_uid` instead.)
option_label - String!
The display text for the option.
value_id - Int!
(Deprecated: Use `SelectedConfigurableOption.configurable_product_option_value_uid` instead.)
value_label - String!
The display name of the selected configurable option.

Example

Copied to your clipboard
{
  "configurable_product_option_uid": "4",
  "configurable_product_option_value_uid": 4,
  "id": 987,
  "option_label": "abc123",
  "value_id": 987,
  "value_label": "xyz789"
}

SelectedCustomAttributeInput

Contains details about an attribute the buyer selected.

Input Fields

Input FieldDescription
attribute_code - String!
A string that identifies the selected attribute.
value - String!
The unique ID for a selected custom attribute value.

Example

Copied to your clipboard
{
  "attribute_code": "xyz789",
  "value": "abc123"
}

SelectedCustomizableOption

Identifies a customized product that has been placed in a cart.

Fields

Field NameDescription
customizable_option_uid - ID!
The unique ID for a specific `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object.
id - Int!
(Deprecated: Use `SelectedCustomizableOption.customizable_option_uid` instead.)
is_required - Boolean!
Indicates whether the customizable option is required.
label - String!
The display name of the selected customizable option.
sort_order - Int!
A value indicating the order to display this option.
type - String!
The type of `CustomizableOptionInterface` object.
values - [SelectedCustomizableOptionValue]!
An array of selectable values.

Example

Copied to your clipboard
{
  "customizable_option_uid": 4,
  "id": 987,
  "is_required": true,
  "label": "abc123",
  "sort_order": 123,
  "type": "xyz789",
  "values": [SelectedCustomizableOptionValue]
}

SelectedCustomizableOptionValue

Identifies the value of the selected customized option.

Fields

Field NameDescription
customizable_option_value_uid - ID!
The unique ID for a value object that corresponds to the object represented by the `customizable_option_uid` attribute.
id - Int!
(Deprecated: Use `SelectedCustomizableOptionValue.customizable_option_value_uid` instead.)
label - String!
The display name of the selected value.
price - CartItemSelectedOptionValuePrice!
The price of the selected customizable value.
value - String!
The text identifying the selected value.

Example

Copied to your clipboard
{
  "customizable_option_value_uid": "4",
  "id": 987,
  "label": "abc123",
  "price": CartItemSelectedOptionValuePrice,
  "value": "abc123"
}

SelectedPaymentMethod

Describes the payment method the shopper selected.

Fields

Field NameDescription
code - String!
The payment method code.
purchase_order_number - String
The purchase order number.
title - String!
The payment method title.

Example

Copied to your clipboard
{
  "code": "abc123",
  "purchase_order_number": "xyz789",
  "title": "abc123"
}

SelectedShippingMethod

Contains details about the selected shipping method and carrier.

Fields

Field NameDescription
amount - Money!
The cost of shipping using this shipping method.
base_amount - Money
(Deprecated: The field should not be used on the storefront.)
carrier_code - String!
A string that identifies a commercial carrier or an offline shipping method.
carrier_title - String!
The label for the carrier code.
method_code - String!
A shipping method code associated with a carrier.
method_title - String!
The label for the method code.
price_excl_tax - Money!
The cost of shipping using this shipping method, excluding tax.
price_incl_tax - Money!
The cost of shipping using this shipping method, including tax.

Example

Copied to your clipboard
{
  "amount": Money,
  "base_amount": Money,
  "carrier_code": "xyz789",
  "carrier_title": "xyz789",
  "method_code": "abc123",
  "method_title": "abc123",
  "price_excl_tax": Money,
  "price_incl_tax": Money
}

SendEmailToFriendInput

Defines the referenced product and the email sender and recipients.

Input Fields

Input FieldDescription
product_id - Int!
The ID of the product that the sender is referencing.
recipients - [SendEmailToFriendRecipientInput]!
An array containing information about each recipient.
sender - SendEmailToFriendSenderInput!
Information about the customer and the content of the message.

Example

Copied to your clipboard
{
  "product_id": 987,
  "recipients": [SendEmailToFriendRecipientInput],
  "sender": SendEmailToFriendSenderInput
}

SendEmailToFriendOutput

Contains information about the sender and recipients.

Fields

Field NameDescription
recipients - [SendEmailToFriendRecipient]
An array containing information about each recipient.
sender - SendEmailToFriendSender
Information about the customer and the content of the message.

Example

Copied to your clipboard
{
  "recipients": [SendEmailToFriendRecipient],
  "sender": SendEmailToFriendSender
}

SendEmailToFriendRecipient

An output object that contains information about the recipient.

Fields

Field NameDescription
email - String!
The email address of the recipient.
name - String!
The name of the recipient.

Example

Copied to your clipboard
{
  "email": "abc123",
  "name": "abc123"
}

SendEmailToFriendRecipientInput

Contains details about a recipient.

Input Fields

Input FieldDescription
email - String!
The email address of the recipient.
name - String!
The name of the recipient.

Example

Copied to your clipboard
{
  "email": "xyz789",
  "name": "xyz789"
}

SendEmailToFriendSender

An output object that contains information about the sender.

Fields

Field NameDescription
email - String!
The email address of the sender.
message - String!
The text of the message to be sent.
name - String!
The name of the sender.

Example

Copied to your clipboard
{
  "email": "xyz789",
  "message": "abc123",
  "name": "xyz789"
}

SendEmailToFriendSenderInput

Contains details about the sender.

Input Fields

Input FieldDescription
email - String!
The email address of the sender.
message - String!
The text of the message to be sent.
name - String!
The name of the sender.

Example

Copied to your clipboard
{
  "email": "abc123",
  "message": "xyz789",
  "name": "abc123"
}

SendFriendConfiguration

Contains details about the configuration of the Email to a Friend feature.

Fields

Field NameDescription
enabled_for_customers - Boolean!
Indicates whether the Email to a Friend feature is enabled.
enabled_for_guests - Boolean!
Indicates whether the Email to a Friend feature is enabled for guests.

Example

Copied to your clipboard
{"enabled_for_customers": true, "enabled_for_guests": false}

SendNegotiableQuoteForReviewInput

Specifies which negotiable quote to send for review.

Input Fields

Input FieldDescription
comment - NegotiableQuoteCommentInput
A comment for the seller to review.
quote_uid - ID!
The unique ID of a `NegotiableQuote` object.

Example

Copied to your clipboard
{
  "comment": NegotiableQuoteCommentInput,
  "quote_uid": "4"
}

SendNegotiableQuoteForReviewOutput

Contains the negotiable quote.

Fields

Field NameDescription
quote - NegotiableQuote
The negotiable quote after sending for seller review.

Example

Copied to your clipboard
{"quote": NegotiableQuote}

SetBillingAddressOnCartInput

Sets the billing address.

Input Fields

Input FieldDescription
billing_address - BillingAddressInput!
The billing address.
cart_id - String!
The unique ID of a `Cart` object.

Example

Copied to your clipboard
{
  "billing_address": BillingAddressInput,
  "cart_id": "xyz789"
}

SetBillingAddressOnCartOutput

Contains details about the cart after setting the billing address.

Fields

Field NameDescription
cart - Cart!
The cart after setting the billing address.

Example

Copied to your clipboard
{"cart": Cart}

SetCartAsInactiveOutput

Sets the cart as inactive

Fields

Field NameDescription
error - String
The error message returned after failing to set the cart as inactive
success - Boolean!
Indicates whether the cart was set as inactive

Example

Copied to your clipboard
{"error": "abc123", "success": false}

SetGiftOptionsOnCartInput

Defines the gift options applied to the cart.

Input Fields

Input FieldDescription
cart_id - String!
The unique ID that identifies the shopper's cart.
gift_message - GiftMessageInput
Gift message details for the cart.
gift_receipt_included - Boolean!
Whether customer requested gift receipt for the cart.
gift_wrapping_id - ID
The unique ID for a `GiftWrapping` object to be used for the cart.
printed_card_included - Boolean!
Whether customer requested printed card for the cart.

Example

Copied to your clipboard
{
  "cart_id": "xyz789",
  "gift_message": GiftMessageInput,
  "gift_receipt_included": false,
  "gift_wrapping_id": "4",
  "printed_card_included": true
}

SetGiftOptionsOnCartOutput

Contains the cart after gift options have been applied.

Fields

Field NameDescription
cart - Cart!
The modified cart object.

Example

Copied to your clipboard
{"cart": Cart}

SetGuestEmailOnCartInput

Defines the guest email and cart.

Input Fields

Input FieldDescription
cart_id - String!
The unique ID of a `Cart` object.
email - String!
The email address of the guest.

Example

Copied to your clipboard
{
  "cart_id": "xyz789",
  "email": "abc123"
}

SetGuestEmailOnCartOutput

Contains details about the cart after setting the email of a guest.

Fields

Field NameDescription
cart - Cart!
The cart after setting the guest email.

Example

Copied to your clipboard
{"cart": Cart}

SetLineItemNoteOutput

Contains the updated negotiable quote.

Fields

Field NameDescription
quote - NegotiableQuote
The negotiable quote after sending for seller review.

Example

Copied to your clipboard
{"quote": NegotiableQuote}

SetNegotiableQuoteBillingAddressInput

Sets the billing address.

Input Fields

Input FieldDescription
billing_address - NegotiableQuoteBillingAddressInput!
The billing address to be added.
quote_uid - ID!
The unique ID of a `NegotiableQuote` object.

Example

Copied to your clipboard
{
  "billing_address": NegotiableQuoteBillingAddressInput,
  "quote_uid": "4"
}

SetNegotiableQuoteBillingAddressOutput

Contains the negotiable quote.

Fields

Field NameDescription
quote - NegotiableQuote
The negotiable quote after assigning a billing address.

Example

Copied to your clipboard
{"quote": NegotiableQuote}

SetNegotiableQuotePaymentMethodInput

Defines the payment method of the specified negotiable quote.

Input Fields

Input FieldDescription
payment_method - NegotiableQuotePaymentMethodInput!
The payment method to be assigned to the negotiable quote.
quote_uid - ID!
The unique ID of a `NegotiableQuote` object.

Example

Copied to your clipboard
{
  "payment_method": NegotiableQuotePaymentMethodInput,
  "quote_uid": 4
}

SetNegotiableQuotePaymentMethodOutput

Contains details about the negotiable quote after setting the payment method.

Fields

Field NameDescription
quote - NegotiableQuote
The updated negotiable quote.

Example

Copied to your clipboard
{"quote": NegotiableQuote}

SetNegotiableQuoteShippingAddressInput

Defines the shipping address to assign to the negotiable quote.

Input Fields

Input FieldDescription
customer_address_id - ID
The unique ID of a `CustomerAddress` object.
quote_uid - ID!
The unique ID of a `NegotiableQuote` object.
shipping_addresses - [NegotiableQuoteShippingAddressInput]
An array of shipping addresses to apply to the negotiable quote.

Example

Copied to your clipboard
{
  "customer_address_id": 4,
  "quote_uid": 4,
  "shipping_addresses": [
    NegotiableQuoteShippingAddressInput
  ]
}

SetNegotiableQuoteShippingAddressOutput

Contains the negotiable quote.

Fields

Field NameDescription
quote - NegotiableQuote
The negotiable quote after assigning a shipping address.

Example

Copied to your clipboard
{"quote": NegotiableQuote}

SetNegotiableQuoteShippingMethodsInput

Defines the shipping method to apply to the negotiable quote.

Input Fields

Input FieldDescription
quote_uid - ID!
The unique ID of a `NegotiableQuote` object.
shipping_methods - [ShippingMethodInput]!
An array of shipping methods to apply to the negotiable quote.

Example

Copied to your clipboard
{
  "quote_uid": 4,
  "shipping_methods": [ShippingMethodInput]
}

SetNegotiableQuoteShippingMethodsOutput

Contains the negotiable quote.

Fields

Field NameDescription
quote - NegotiableQuote
The negotiable quote after applying shipping methods.

Example

Copied to your clipboard
{"quote": NegotiableQuote}

SetNegotiableQuoteTemplateShippingAddressInput

Defines the shipping address to assign to the negotiable quote template.

Input Fields

Input FieldDescription
shipping_address - NegotiableQuoteTemplateShippingAddressInput!
A shipping adadress to apply to the negotiable quote template.
template_id - ID!
The unique ID of a `NegotiableQuote` object.

Example

Copied to your clipboard
{
  "shipping_address": NegotiableQuoteTemplateShippingAddressInput,
  "template_id": "4"
}

SetPaymentMethodAndPlaceOrderInput

Applies a payment method to the quote.

Input Fields

Input FieldDescription
cart_id - String!
The unique ID of a `Cart` object.
payment_method - PaymentMethodInput!
The payment method data to apply to the cart.

Example

Copied to your clipboard
{
  "cart_id": "xyz789",
  "payment_method": PaymentMethodInput
}

SetPaymentMethodOnCartInput

Applies a payment method to the cart.

Input Fields

Input FieldDescription
cart_id - String!
The unique ID of a `Cart` object.
payment_method - PaymentMethodInput!
The payment method data to apply to the cart.

Example

Copied to your clipboard
{
  "cart_id": "abc123",
  "payment_method": PaymentMethodInput
}

SetPaymentMethodOnCartOutput

Contains details about the cart after setting the payment method.

Fields

Field NameDescription
cart - Cart!
The cart after setting the payment method.

Example

Copied to your clipboard
{"cart": Cart}

SetShippingAddressesOnCartInput

Specifies an array of addresses to use for shipping.

Input Fields

Input FieldDescription
cart_id - String!
The unique ID of a `Cart` object.
shipping_addresses - [ShippingAddressInput]!
An array of shipping addresses.

Example

Copied to your clipboard
{
  "cart_id": "xyz789",
  "shipping_addresses": [ShippingAddressInput]
}

SetShippingAddressesOnCartOutput

Contains details about the cart after setting the shipping addresses.

Fields

Field NameDescription
cart - Cart!
The cart after setting the shipping addresses.

Example

Copied to your clipboard
{"cart": Cart}

SetShippingMethodsOnCartInput

Applies one or shipping methods to the cart.

Input Fields

Input FieldDescription
cart_id - String!
The unique ID of a `Cart` object.
shipping_methods - [ShippingMethodInput]!
An array of shipping methods.

Example

Copied to your clipboard
{
  "cart_id": "abc123",
  "shipping_methods": [ShippingMethodInput]
}

SetShippingMethodsOnCartOutput

Contains details about the cart after setting the shipping methods.

Fields

Field NameDescription
cart - Cart!
The cart after setting the shipping methods.

Example

Copied to your clipboard
{"cart": Cart}

ShareGiftRegistryInviteeInput

Defines a gift registry invitee.

Input Fields

Input FieldDescription
email - String!
The email address of the gift registry invitee.
name - String!
The name of the gift registry invitee.

Example

Copied to your clipboard
{
  "email": "xyz789",
  "name": "xyz789"
}

ShareGiftRegistryOutput

Contains the results of a request to share a gift registry.

Fields

Field NameDescription
is_shared - Boolean!
Indicates whether the gift registry was successfully shared.

Example

Copied to your clipboard
{"is_shared": false}

ShareGiftRegistrySenderInput

Defines the sender of an invitation to view a gift registry.

Input Fields

Input FieldDescription
message - String!
A brief message from the sender.
name - String!
The sender of the gift registry invitation.

Example

Copied to your clipboard
{
  "message": "abc123",
  "name": "xyz789"
}

ShipBundleItemsEnum

Defines whether bundle items must be shipped together.

Values

Enum ValueDescription
TOGETHER
SEPARATELY

Example

Copied to your clipboard
""TOGETHER""

ShipmentItem

Fields

Field NameDescription
id - ID!
The unique ID for a `ShipmentItemInterface` object.
order_item - OrderItemInterface
The order item associated with the shipment item.
product_name - String
The name of the base product.
product_sale_price - Money!
The sale price for the base product.
product_sku - String!
The SKU of the base product.
quantity_shipped - Float!
The number of shipped items.

Example

Copied to your clipboard
{
  "id": 4,
  "order_item": OrderItemInterface,
  "product_name": "abc123",
  "product_sale_price": Money,
  "product_sku": "xyz789",
  "quantity_shipped": 987.65
}

ShipmentItemInterface

Order shipment item details.

Fields

Field NameDescription
id - ID!
The unique ID for a `ShipmentItemInterface` object.
order_item - OrderItemInterface
The order item associated with the shipment item.
product_name - String
The name of the base product.
product_sale_price - Money!
The sale price for the base product.
product_sku - String!
The SKU of the base product.
quantity_shipped - Float!
The number of shipped items.

Possible Types

ShipmentItemInterface Types
BundleShipmentItem
GiftCardShipmentItem
ShipmentItem

Example

Copied to your clipboard
{
  "id": "4",
  "order_item": OrderItemInterface,
  "product_name": "xyz789",
  "product_sale_price": Money,
  "product_sku": "xyz789",
  "quantity_shipped": 987.65
}

ShipmentTracking

Contains order shipment tracking details.

Fields

Field NameDescription
carrier - String!
The shipping carrier for the order delivery.
number - String
The tracking number of the order shipment.
title - String!
The shipment tracking title.

Example

Copied to your clipboard
{
  "carrier": "abc123",
  "number": "abc123",
  "title": "xyz789"
}

ShippingAddressInput

Defines a single shipping address.

Input Fields

Input FieldDescription
address - CartAddressInput
Defines a shipping address.
customer_address_id - Int
An ID from the customer's address book that uniquely identifies the address to be used for shipping.
customer_address_uid - ID
The unique ID from the customer's address book that uniquely identifies the address to be used for shipping.
customer_notes - String
Text provided by the shopper.
pickup_location_code - String
The code of Pickup Location which will be used for In-Store Pickup.

Example

Copied to your clipboard
{
  "address": CartAddressInput,
  "customer_address_id": 987,
  "customer_address_uid": 4,
  "customer_notes": "xyz789",
  "pickup_location_code": "xyz789"
}

ShippingCartAddress

Contains shipping addresses and methods.

Fields

Field NameDescription
available_shipping_methods - [AvailableShippingMethod]
An array that lists the shipping methods that can be applied to the cart.
cart_items - [CartItemQuantity]
(Deprecated: Use `cart_items_v2` instead.)
cart_items_v2 - [CartItemInterface]
An array that lists the items in the cart.
city - String!
The city specified for the billing or shipping address.
company - String
The company specified for the billing or shipping address.
country - CartAddressCountry!
An object containing the country label and code.
custom_attributes - [AttributeValueInterface]!
The custom attribute values of the billing or shipping address.
customer_address_uid - ID
The unique ID from the customer's address book that uniquely identifies the address.
customer_notes - String
Text provided by the shopper.
fax - String
The customer's fax number.
firstname - String!
The first name of the customer or guest.
id - Int
Id of the customer address. (Deprecated: Use `customer_address_uid` instead.)
items_weight - Float
(Deprecated: This information should not be exposed on the frontend.)
lastname - String!
The last name of the customer or guest.
middlename - String
The middle name of the person associated with the billing/shipping address.
pickup_location_code - String
postcode - String
The ZIP or postal code of the billing or shipping address.
prefix - String
An honorific, such as Dr., Mr., or Mrs.
region - CartAddressRegion
An object containing the region label and code.
same_as_billing - Boolean!
Indicates whether the shipping address is same as billing address.
selected_shipping_method - SelectedShippingMethod
An object that describes the selected shipping method.
street - [String]!
An array containing the street for the billing or shipping address.
suffix - String
A value such as Sr., Jr., or III.
telephone - String
The telephone number for the billing or shipping address.
uid - ID!
The unique id of the customer cart address.
vat_id - String
The VAT company number for billing or shipping address.

Example

Copied to your clipboard
{
  "available_shipping_methods": [AvailableShippingMethod],
  "cart_items": [CartItemQuantity],
  "cart_items_v2": [CartItemInterface],
  "city": "abc123",
  "company": "xyz789",
  "country": CartAddressCountry,
  "custom_attributes": [AttributeValueInterface],
  "customer_address_uid": 4,
  "customer_notes": "xyz789",
  "fax": "xyz789",
  "firstname": "abc123",
  "id": 987,
  "items_weight": 123.45,
  "lastname": "xyz789",
  "middlename": "abc123",
  "pickup_location_code": "abc123",
  "postcode": "abc123",
  "prefix": "abc123",
  "region": CartAddressRegion,
  "same_as_billing": false,
  "selected_shipping_method": SelectedShippingMethod,
  "street": ["abc123"],
  "suffix": "abc123",
  "telephone": "abc123",
  "uid": 4,
  "vat_id": "xyz789"
}

ShippingDiscount

Defines an individual shipping discount. This discount can be applied to shipping.

Fields

Field NameDescription
amount - Money!
The amount of the discount.

Example

Copied to your clipboard
{"amount": Money}

ShippingHandling

Contains details about shipping and handling costs.

Fields

Field NameDescription
amount_excluding_tax - Money
The shipping amount, excluding tax.
amount_including_tax - Money
The shipping amount, including tax.
discounts - [ShippingDiscount]
The applied discounts to the shipping.
taxes - [TaxItem]
Details about taxes applied for shipping.
total_amount - Money!
The total amount for shipping.

Example

Copied to your clipboard
{
  "amount_excluding_tax": Money,
  "amount_including_tax": Money,
  "discounts": [ShippingDiscount],
  "taxes": [TaxItem],
  "total_amount": Money
}

ShippingMethodInput

Defines the shipping carrier and method.

Input Fields

Input FieldDescription
carrier_code - String!
A string that identifies a commercial carrier or an offline delivery method.
method_code - String!
A string that indicates which service a commercial carrier will use to ship items. For offline delivery methods, this value is similar to the label displayed on the checkout page.

Example

Copied to your clipboard
{
  "carrier_code": "abc123",
  "method_code": "abc123"
}

SimpleCartItem

An implementation for simple product cart items.

Fields

Field NameDescription
available_gift_wrapping - [GiftWrapping]!
The list of available gift wrapping options for the cart item.
customizable_options - [SelectedCustomizableOption]!
An array containing the customizable options the shopper selected.
discount - [Discount]
Contains discount for quote line item.
errors - [CartItemError]
An array of errors encountered while loading the cart item
gift_message - GiftMessage
The entered gift message for the cart item
gift_wrapping - GiftWrapping
The selected gift wrapping for the cart item.
id - String!
(Deprecated: Use `uid` instead.)
is_available - Boolean!
True if requested quantity is less than available stock, false otherwise.
max_qty - Float
Line item max qty in quote template
min_qty - Float
Line item min qty in quote template
not_available_message - String
Message to display when the product is not available with this selected option.
note_from_buyer - [ItemNote]
The buyer's quote line item note.
note_from_seller - [ItemNote]
The seller's quote line item note.
prices - CartItemPrices
Contains details about the price of the item, including taxes and discounts.
product - ProductInterface!
Details about an item in the cart.
quantity - Float!
The quantity of this item in the cart.
uid - ID!
The unique ID for a `CartItemInterface` object.

Example

Copied to your clipboard
{
  "available_gift_wrapping": [GiftWrapping],
  "customizable_options": [SelectedCustomizableOption],
  "discount": [Discount],
  "errors": [CartItemError],
  "gift_message": GiftMessage,
  "gift_wrapping": GiftWrapping,
  "id": "xyz789",
  "is_available": true,
  "max_qty": 987.65,
  "min_qty": 987.65,
  "not_available_message": "abc123",
  "note_from_buyer": [ItemNote],
  "note_from_seller": [ItemNote],
  "prices": CartItemPrices,
  "product": ProductInterface,
  "quantity": 123.45,
  "uid": "4"
}

SimpleProduct

Defines a simple product, which is tangible and is usually sold in single units or in fixed quantities.

Fields

Field NameDescription
attribute_set_id - Int
The attribute set assigned to the product. (Deprecated: The field should not be used on the storefront.)
canonical_url - String
The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.
categories - [CategoryInterface]
The categories assigned to a product.
color - Int
(Deprecated: Use the `custom_attributes` field instead.)
country_of_manufacture - String
The product's country of origin.
created_at - String
Timestamp indicating when the product was created. (Deprecated: The field should not be used on the storefront.)
crosssell_products - [ProductInterface]
An array of cross-sell products.
custom_attributesV2 - ProductCustomAttributes
Product custom attributes.
description - ComplexTextValue
Detailed information about the product. The value can include simple HTML tags.
gift_message_available - Boolean!
Returns a value indicating gift message availability for the product.
gift_wrapping_available - Boolean!
Returns a value indicating gift wrapping availability for the product.
gift_wrapping_price - Money
Returns value and currency indicating gift wrapping price for the product.
id - Int
The ID number assigned to the product. (Deprecated: Use the `uid` field instead.)
image - ProductImage
The relative path to the main image on the product page.
is_returnable - String
Indicates whether the product can be returned.
manufacturer - Int
A number representing the product's manufacturer. (Deprecated: Use the `custom_attributes` field instead.)
max_sale_qty - Float
Maximum Qty Allowed in Shopping Cart
media_gallery - [MediaGalleryInterface]
An array of media gallery objects.
media_gallery_entries - [MediaGalleryEntry]
An array of MediaGalleryEntry objects. (Deprecated: Use `media_gallery` instead.)
meta_description - String
A brief overview of the product for search results listings, maximum 255 characters.
meta_keyword - String
A comma-separated list of keywords that are visible only to search engines.
meta_title - String
A string that is displayed in the title bar and tab of the browser and in search results lists.
min_sale_qty - Float
Minimum Qty Allowed in Shopping Cart
name - String
The product name. Customers use this name to identify the product.
new_from_date - String
The beginning date for new product listings, and determines if the product is featured as a new product.
new_to_date - String
The end date for new product listings.
only_x_left_in_stock - Float
Product stock only x left count
options - [CustomizableOptionInterface]
An array of options for a customizable product.
options_container - String
If the product has multiple options, determines where they appear on the product page.
price - ProductPrices
Indicates the price of an item. (Deprecated: Use `price_range` for product price information.)
price_range - PriceRange!
The range of prices for the product
price_tiers - [TierPrice]
An array of `TierPrice` objects.
product_links - [ProductLinksInterface]
An array of `ProductLinks` objects.
quantity - Float
Amount of available stock
rating_summary - Float!
The average of all the ratings given to the product.
redirect_code - Int!
Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.
related_products - [ProductInterface]
An array of related products.
relative_url - String
The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.
review_count - Int!
The total count of all the reviews given to the product.
reviews - ProductReviews!
The list of products reviews.
short_description - ComplexTextValue
A short description of the product. Its use depends on the theme.
sku - String
A number or code assigned to a product to identify the product, options, price, and manufacturer.
small_image - ProductImage
The relative path to the small image, which is used on catalog pages.
special_from_date - String
The beginning date that a product has a special price. (Deprecated: The field should not be used on the storefront.)
special_price - Float
The discounted price of the product.
special_to_date - String
The end date for a product with a special price.
staged - Boolean!
Indicates whether the product is staged for a future campaign.
stock_status - ProductStockStatus
Stock status of the product
swatch_image - String
The file name of a swatch image.
thumbnail - ProductImage
The relative path to the product's thumbnail image.
tier_price - Float
The price when tier pricing is in effect and the items purchased threshold has been reached. (Deprecated: Use `price_tiers` for product tier price information.)
tier_prices - [ProductTierPrices]
An array of ProductTierPrices objects. (Deprecated: Use `price_tiers` for product tier price information.)
type - UrlRewriteEntityTypeEnum
One of PRODUCT, CATEGORY, or CMS_PAGE.
type_id - String
One of simple, virtual, bundle, downloadable, grouped, or configurable. (Deprecated: Use `__typename` instead.)
uid - ID!
The unique ID for a `ProductInterface` object.
updated_at - String
Timestamp indicating when the product was updated. (Deprecated: The field should not be used on the storefront.)
upsell_products - [ProductInterface]
An array of up-sell products.
url_key - String
The part of the URL that identifies the product
url_path - String
(Deprecated: Use product's `canonical_url` or url rewrites instead)
url_rewrites - [UrlRewrite]
URL rewrites list
url_suffix - String
The part of the product URL that is appended after the url key
websites - [Website]
An array of websites in which the product is available. (Deprecated: The field should not be used on the storefront.)
weight - Float
The weight of the item, in units defined by the store.

Example

Copied to your clipboard
{
  "attribute_set_id": 987,
  "canonical_url": "abc123",
  "categories": [CategoryInterface],
  "color": 987,
  "country_of_manufacture": "abc123",
  "created_at": "xyz789",
  "crosssell_products": [ProductInterface],
  "custom_attributesV2": ProductCustomAttributes,
  "description": ComplexTextValue,
  "gift_message_available": false,
  "gift_wrapping_available": true,
  "gift_wrapping_price": Money,
  "id": 123,
  "image": ProductImage,
  "is_returnable": "abc123",
  "manufacturer": 123,
  "max_sale_qty": 987.65,
  "media_gallery": [MediaGalleryInterface],
  "media_gallery_entries": [MediaGalleryEntry],
  "meta_description": "xyz789",
  "meta_keyword": "abc123",
  "meta_title": "xyz789",
  "min_sale_qty": 123.45,
  "name": "xyz789",
  "new_from_date": "xyz789",
  "new_to_date": "xyz789",
  "only_x_left_in_stock": 123.45,
  "options": [CustomizableOptionInterface],
  "options_container": "abc123",
  "price": ProductPrices,
  "price_range": PriceRange,
  "price_tiers": [TierPrice],
  "product_links": [ProductLinksInterface],
  "quantity": 987.65,
  "rating_summary": 987.65,
  "redirect_code": 987,
  "related_products": [ProductInterface],
  "relative_url": "xyz789",
  "review_count": 123,
  "reviews": ProductReviews,
  "short_description": ComplexTextValue,
  "sku": "abc123",
  "small_image": ProductImage,
  "special_from_date": "abc123",
  "special_price": 123.45,
  "special_to_date": "xyz789",
  "staged": true,
  "stock_status": "IN_STOCK",
  "swatch_image": "xyz789",
  "thumbnail": ProductImage,
  "tier_price": 987.65,
  "tier_prices": [ProductTierPrices],
  "type": "CMS_PAGE",
  "type_id": "abc123",
  "uid": "4",
  "updated_at": "xyz789",
  "upsell_products": [ProductInterface],
  "url_key": "abc123",
  "url_path": "abc123",
  "url_rewrites": [UrlRewrite],
  "url_suffix": "abc123",
  "websites": [Website],
  "weight": 987.65
}

SimpleProductCartItemInput

Defines a single product to add to the cart.

Input Fields

Input FieldDescription
customizable_options - [CustomizableOptionInput]
An array that defines customizable options for the product.
data - CartItemInput!
An object containing the `sku`, `quantity`, and other relevant information about the product.

Example

Copied to your clipboard
{
  "customizable_options": [CustomizableOptionInput],
  "data": CartItemInput
}

SimpleRequisitionListItem

Contains details about simple products added to a requisition list.

Fields

Field NameDescription
customizable_options - [SelectedCustomizableOption]!
Selected custom options for an item in the requisition list.
product - ProductInterface!
Details about a requisition list item.
quantity - Float!
The amount added.
uid - ID!
The unique ID for the requisition list item.

Example

Copied to your clipboard
{
  "customizable_options": [SelectedCustomizableOption],
  "product": ProductInterface,
  "quantity": 123.45,
  "uid": "4"
}

SimpleWishlistItem

Contains a simple product wish list item.

Fields

Field NameDescription
added_at - String!
The date and time the item was added to the wish list.
customizable_options - [SelectedCustomizableOption]!
Custom options selected for the wish list item.
description - String
The description of the item.
id - ID!
The unique ID for a `WishlistItemInterface` object.
product - ProductInterface
Product details of the wish list item.
quantity - Float!
The quantity of this wish list item.

Example

Copied to your clipboard
{
  "added_at": "xyz789",
  "customizable_options": [SelectedCustomizableOption],
  "description": "xyz789",
  "id": 4,
  "product": ProductInterface,
  "quantity": 123.45
}

SmartButtonMethodInput

Smart button payment inputs

Input Fields

Input FieldDescription
payment_source - String
The payment source for the payment method
payments_order_id - String
The payment services order ID
paypal_order_id - String
PayPal order ID

Example

Copied to your clipboard
{
  "payment_source": "xyz789",
  "payments_order_id": "xyz789",
  "paypal_order_id": "xyz789"
}

SmartButtonsConfig

Fields

Field NameDescription
app_switch_when_available - Boolean
Indicated whether to use App Switch on enabled mobile devices
button_styles - ButtonStyles
The styles for the PayPal Smart Button configuration
code - String
The payment method code as defined in the payment gateway
display_message - Boolean
Indicates whether to display the PayPal Pay Later message
display_venmo - Boolean
Indicates whether to display Venmo
is_visible - Boolean
Indicates whether the payment method is displayed
message_styles - MessageStyles
Contains details about the styles for the PayPal Pay Later message
payment_intent - String
Defines the payment intent (Authorize or Capture
sdk_params - [SDKParams]
The PayPal parameters required to load the JS SDK
sort_order - String
The relative order the payment method is displayed on the checkout page
title - String
The name displayed for the payment method

Example

Copied to your clipboard
{
  "app_switch_when_available": true,
  "button_styles": ButtonStyles,
  "code": "abc123",
  "display_message": false,
  "display_venmo": false,
  "is_visible": true,
  "message_styles": MessageStyles,
  "payment_intent": "abc123",
  "sdk_params": [SDKParams],
  "sort_order": "xyz789",
  "title": "xyz789"
}

SortEnum

Indicates whether to return results in ascending or descending order.

Values

Enum ValueDescription
ASC
DESC

Example

Copied to your clipboard
""ASC""

SortField

Defines a possible sort field.

Fields

Field NameDescription
label - String
The label of the sort field.
value - String
The attribute code of the sort field.

Example

Copied to your clipboard
{
  "label": "abc123",
  "value": "abc123"
}

SortFields

Contains a default value for sort fields and all available sort fields.

Fields

Field NameDescription
default - String
The default sort field value.
options - [SortField]
An array of possible sort fields.

Example

Copied to your clipboard
{
  "default": "abc123",
  "options": [SortField]
}

SortQuoteItemsEnum

Specifies the field to use for sorting quote items

Values

Enum ValueDescription
ITEM_ID
CREATED_AT
UPDATED_AT
PRODUCT_ID
SKU
NAME
DESCRIPTION
WEIGHT
QTY
PRICE
BASE_PRICE
CUSTOM_PRICE
DISCOUNT_PERCENT
DISCOUNT_AMOUNT
BASE_DISCOUNT_AMOUNT
TAX_PERCENT
TAX_AMOUNT
BASE_TAX_AMOUNT
ROW_TOTAL
BASE_ROW_TOTAL
ROW_TOTAL_WITH_DISCOUNT
ROW_WEIGHT
PRODUCT_TYPE
BASE_TAX_BEFORE_DISCOUNT
TAX_BEFORE_DISCOUNT
ORIGINAL_CUSTOM_PRICE
PRICE_INC_TAX
BASE_PRICE_INC_TAX
ROW_TOTAL_INC_TAX
BASE_ROW_TOTAL_INC_TAX
DISCOUNT_TAX_COMPENSATION_AMOUNT
BASE_DISCOUNT_TAX_COMPENSATION_AMOUNT
FREE_SHIPPING

Example

Copied to your clipboard
""ITEM_ID""

StoreConfig

Contains information about a store's configuration.

Fields

Field NameDescription
absolute_footer - String
Contains scripts that must be included in the HTML before the closing `<body>` tag.
allow_gift_receipt - String
Indicates if the gift sender has the option to send a gift receipt. Possible values: 1 (Yes) and 0 (No).
allow_gift_wrapping_on_order - String
Indicates whether gift wrapping can be added for the entire order. Possible values: 1 (Yes) and 0 (No).
allow_gift_wrapping_on_order_items - String
Indicates whether gift wrapping can be added for individual order items. Possible values: 1 (Yes) and 0 (No).
allow_guests_to_write_product_reviews - String
Indicates whether guest users can write product reviews. Possible values: 1 (Yes) and 0 (No).
allow_items - String
The value of the Allow Gift Messages for Order Items option
allow_order - String
The value of the Allow Gift Messages on Order Level option
allow_printed_card - String
Indicates if a printed card can accompany an order. Possible values: 1 (Yes) and 0 (No).
autocomplete_on_storefront - Boolean
Indicates whether to enable autocomplete on login and forgot password forms.
base_currency_code - String
The base currency code.
base_link_url - String
A fully-qualified URL that is used to create relative links to the `base_url`.
base_media_url - String
The fully-qualified URL that specifies the location of media files.
base_static_url - String
The fully-qualified URL that specifies the location of static view files.
base_url - String
The store’s fully-qualified base URL.
braintree_3dsecure_allowspecific - Boolean
Braintree 3D Secure, should 3D Secure be used for specific countries.
braintree_3dsecure_always_request_3ds - Boolean
Braintree 3D Secure, always request 3D Secure flag.
braintree_3dsecure_specificcountry - String
Braintree 3D Secure, the specific countries to use 3D Secure in, to be used if allow specific is status is enabled.
braintree_3dsecure_threshold_amount - String
Braintree 3D Secure, threshold above which 3D Secure should be requested.
braintree_3dsecure_verify_3dsecure - Boolean
Braintree 3D Secure enabled/active status.
braintree_ach_direct_debit_vault_active - Boolean
Braintree ACH vault status.
braintree_applepay_merchant_name - String
Braintree Apple Pay merchant name.
braintree_applepay_vault_active - Boolean
Braintree Apple Pay vault status.
braintree_cc_vault_active - String
Braintree cc vault status.
braintree_cc_vault_cvv - Boolean
Braintree cc vault CVV re-verification enabled status.
braintree_environment - String
Braintree environment.
braintree_googlepay_btn_color - String
Braintree Google Pay button color.
braintree_googlepay_cctypes - String
Braintree Google Pay Card types supported.
braintree_googlepay_merchant_id - String
Braintree Google Pay merchant ID.
braintree_googlepay_vault_active - Boolean
Braintree Google Pay vault status.
braintree_local_payment_allowed_methods - String
Braintree Local Payment Methods allowed payment methods.
braintree_local_payment_fallback_button_text - String
Braintree Local Payment Methods fallback button text.
braintree_local_payment_redirect_on_fail - String
Braintree Local Payment Methods redirect URL on failed payment.
braintree_merchant_account_id - String
Braintree Merchant Account ID.
braintree_paypal_button_location_cart_type_credit_color - String
Braintree PayPal Credit mini-cart & cart button style color.
braintree_paypal_button_location_cart_type_credit_label - String
Braintree PayPal Credit mini-cart & cart button style label.
braintree_paypal_button_location_cart_type_credit_shape - String
Braintree PayPal Credit mini-cart & cart button style shape.
braintree_paypal_button_location_cart_type_credit_show - Boolean
Braintree PayPal Credit mini-cart & cart button show status.
braintree_paypal_button_location_cart_type_messaging_layout - String
Braintree PayPal Pay Later messaging mini-cart & cart style layout.
braintree_paypal_button_location_cart_type_messaging_logo - String
Braintree PayPal Pay Later messaging mini-cart & cart style logo.
braintree_paypal_button_location_cart_type_messaging_logo_position - String
Braintree PayPal Pay Later messaging mini-cart & cart style logo position.
braintree_paypal_button_location_cart_type_messaging_show - Boolean
Braintree PayPal Pay Later messaging mini-cart & cart show status.
braintree_paypal_button_location_cart_type_messaging_text_color - String
Braintree PayPal Pay Later messaging checkout style text color.
braintree_paypal_button_location_cart_type_paylater_color - String
Braintree PayPal Pay Later mini-cart & cart button style color.
braintree_paypal_button_location_cart_type_paylater_label - String
Braintree PayPal Pay Later mini-cart & cart button style label.
braintree_paypal_button_location_cart_type_paylater_shape - String
Braintree PayPal Pay Later mini-cart & cart button style shape.
braintree_paypal_button_location_cart_type_paylater_show - Boolean
Braintree PayPal Pay Later mini-cart & cart button show status.
braintree_paypal_button_location_cart_type_paypal_color - String
Braintree PayPal mini-cart & cart button style color.
braintree_paypal_button_location_cart_type_paypal_label - String
Braintree PayPal mini-cart & cart button style label.
braintree_paypal_button_location_cart_type_paypal_shape - String
Braintree PayPal mini-cart & cart button style shape.
braintree_paypal_button_location_cart_type_paypal_show - Boolean
Braintree PayPal mini-cart & cart button show.
braintree_paypal_button_location_checkout_type_credit_color - String
Braintree PayPal Credit checkout button style color.
braintree_paypal_button_location_checkout_type_credit_label - String
Braintree PayPal Credit checkout button style label.
braintree_paypal_button_location_checkout_type_credit_shape - String
Braintree PayPal Credit checkout button style shape.
braintree_paypal_button_location_checkout_type_credit_show - Boolean
Braintree PayPal Credit checkout button show status.
braintree_paypal_button_location_checkout_type_messaging_layout - String
Braintree PayPal Pay Later messaging checkout style layout.
braintree_paypal_button_location_checkout_type_messaging_logo - String
Braintree PayPal Pay Later messaging checkout style logo.
braintree_paypal_button_location_checkout_type_messaging_logo_position - String
Braintree PayPal Pay Later messaging checkout style logo position.
braintree_paypal_button_location_checkout_type_messaging_show - Boolean
Braintree PayPal Pay Later messaging checkout show status.
braintree_paypal_button_location_checkout_type_messaging_text_color - String
Braintree PayPal Pay Later messaging checkout style text color.
braintree_paypal_button_location_checkout_type_paylater_color - String
Braintree PayPal Pay Later checkout button style color.
braintree_paypal_button_location_checkout_type_paylater_label - String
Braintree PayPal Pay Later checkout button style label.
braintree_paypal_button_location_checkout_type_paylater_shape - String
Braintree PayPal Pay Later checkout button style shape.
braintree_paypal_button_location_checkout_type_paylater_show - Boolean
Braintree PayPal Pay Later checkout button show status.
braintree_paypal_button_location_checkout_type_paypal_color - String
Braintree PayPal checkout button style color.
braintree_paypal_button_location_checkout_type_paypal_label - String
Braintree PayPal checkout button style label.
braintree_paypal_button_location_checkout_type_paypal_shape - String
Braintree PayPal checkout button style shape.
braintree_paypal_button_location_checkout_type_paypal_show - Boolean
Braintree PayPal checkout button show.
braintree_paypal_button_location_productpage_type_credit_color - String
Braintree PayPal Credit PDP button style color.
braintree_paypal_button_location_productpage_type_credit_label - String
Braintree PayPal Credit PDP button style label.
braintree_paypal_button_location_productpage_type_credit_shape - String
Braintree PayPal Credit PDP button style shape.
braintree_paypal_button_location_productpage_type_credit_show - Boolean
Braintree PayPal Credit PDP button show status.
braintree_paypal_button_location_productpage_type_messaging_layout - String
Braintree PayPal Pay Later messaging PDP style layout.
braintree_paypal_button_location_productpage_type_messaging_logo - String
Braintree PayPal Pay Later messaging PDP style logo.
braintree_paypal_button_location_productpage_type_messaging_logo_position - String
Braintree PayPal Pay Later messaging PDP style logo position.
braintree_paypal_button_location_productpage_type_messaging_show - Boolean
Braintree PayPal Pay Later messaging PDP show status.
braintree_paypal_button_location_productpage_type_messaging_text_color - String
Braintree PayPal Pay Later messaging PDP style text color.
braintree_paypal_button_location_productpage_type_paylater_color - String
Braintree PayPal Pay Later PDP button style color.
braintree_paypal_button_location_productpage_type_paylater_label - String
Braintree PayPal Pay Later PDP button style label.
braintree_paypal_button_location_productpage_type_paylater_shape - String
Braintree PayPal Pay Later PDP button style shape.
braintree_paypal_button_location_productpage_type_paylater_show - Boolean
Braintree PayPal Pay Later PDP button show status.
braintree_paypal_button_location_productpage_type_paypal_color - String
Braintree PayPal PDP button style color.
braintree_paypal_button_location_productpage_type_paypal_label - String
Braintree PayPal PDP button style label.
braintree_paypal_button_location_productpage_type_paypal_shape - String
Braintree PayPal PDP button style shape.
braintree_paypal_button_location_productpage_type_paypal_show - Boolean
Braintree PayPal PDP button show.
braintree_paypal_credit_uk_merchant_name - String
Braintree PayPal Credit Merchant Name on the FCA Register.
braintree_paypal_display_on_shopping_cart - Boolean
Should display Braintree PayPal in mini-cart & cart?
braintree_paypal_merchant_country - String
Braintree PayPal merchant's country.
braintree_paypal_merchant_name_override - String
Braintree PayPal override for Merchant Name.
braintree_paypal_require_billing_address - Boolean
Does Braintree PayPal require the customer's billing address?
braintree_paypal_send_cart_line_items - Boolean
Does Braintree PayPal require the order line items?
braintree_paypal_vault_active - Boolean
Braintree PayPal vault status.
cart_expires_in_days - Int
checkout/cart/delete_quote_after: quote lifetime in days.
cart_gift_wrapping - String
Indicates if gift wrapping prices are displayed on the Shopping Cart page. Possible values: 1 (Yes) and 0 (No).
cart_merge_preference - String!
Configuration data from checkout/cart/cart_merge_preference
cart_printed_card - String
Indicates if printed card prices are displayed on the Shopping Cart page. Possible values: 1 (Yes) and 0 (No).
cart_summary_display_quantity - Int
checkout/cart_link/use_qty: what to show in the display cart summary, number of items or item quantities.
catalog_default_sort_by - String
The default sort order of the search results list.
category_fixed_product_tax_display_setting - FixedProductTaxDisplaySettings
Corresponds to the 'Display Prices In Product Lists' field in the Admin. It indicates how FPT information is displayed on category pages.
category_url_suffix - String
The suffix applied to category pages, such as `.htm` or `.html`.
check_money_order_enable_for_specific_countries - Boolean
Indicates whether only specific countries can use this payment method.
check_money_order_enabled - Boolean
Indicates whether the Check/Money Order payment method is enabled.
check_money_order_make_check_payable_to - String
The name of the party to whom the check must be payable.
check_money_order_max_order_total - String
The maximum order amount required to qualify for the Check/Money Order payment method.
check_money_order_min_order_total - String
The minimum order amount required to qualify for the Check/Money Order payment method.
check_money_order_new_order_status - String
The status of new orders placed using the Check/Money Order payment method.
check_money_order_payment_from_specific_countries - String
A comma-separated list of specific countries allowed to use the Check/Money Order payment method.
check_money_order_send_check_to - String
The full street address or PO Box where the checks are mailed.
check_money_order_sort_order - Int
A number indicating the position of the Check/Money Order payment method in the list of available payment methods during checkout.
check_money_order_title - String
The title of the Check/Money Order payment method displayed on the storefront.
cms_home_page - String
The name of the CMS page that identifies the home page for the store.
cms_no_cookies - String
A specific CMS page that displays when cookies are not enabled for the browser.
cms_no_route - String
A specific CMS page that displays when a 404 'Page Not Found' error occurs.
code - String
A code assigned to the store to identify it. (Deprecated: Use `store_code` instead.)
configurable_product_image - ProductImageThumbnail!
checkout/cart/configurable_product_image: which image to use for configurable products.
configurable_thumbnail_source - String
Indicates whether the `parent` or child (`itself`) thumbnail should be used in the cart for configurable products.
contact_enabled - Boolean!
Indicates whether the Contact Us form in enabled.
copyright - String
The copyright statement that appears at the bottom of each page.
countries_with_required_region - String
Extended Config Data - general/region/state_required
create_account_confirmation - Boolean
Indicates if the new accounts need confirmation.
customer_access_token_lifetime - Float
Customer access token lifetime.
default_country - String
Extended Config Data - general/country/default
default_description - String
The description that provides a summary of your site for search engine listings. It should not be more than 160 characters in length.
default_display_currency_code - String
The default display currency code.
default_keywords - String
A series of keywords that describe your store, each separated by a comma.
default_title - String
The title that appears at the title bar of each page when viewed in a browser.
demonotice - Int
Controls the display of the demo store notice at the top of the page. Options: 0 (No) or 1 (Yes).
display_product_prices_in_catalog - Int!
Configuration data from tax/display/type
display_shipping_prices - Int!
Configuration data from tax/display/shipping
display_state_if_optional - Boolean
Extended Config Data - general/region/display_all
enable_multiple_wishlists - String
Indicates whether customers can have multiple wish lists. Possible values: 1 (Yes) and 0 (No).
fixed_product_taxes_apply_tax_to_fpt - Boolean!
Configuration data from tax/weee/apply_vat
fixed_product_taxes_display_prices_in_emails - Int!
Configuration data from tax/weee/display_email
fixed_product_taxes_display_prices_in_product_lists - Int!
Configuration data from tax/weee/display_list
fixed_product_taxes_display_prices_in_sales_modules - Int!
Configuration data from tax/weee/display_sales
fixed_product_taxes_display_prices_on_product_view_page - Int!
Configuration data from tax/weee/display
fixed_product_taxes_enable - Boolean!
Configuration data from tax/weee/enable
fixed_product_taxes_include_fpt_in_subtotal - Boolean!
Configuration data from tax/weee/include_in_subtotal
front - String
The landing page that is associated with the base URL.
graphql_share_customer_group - Boolean
Configuration data from customer/account_information/graphql_share_customer_group
grid_per_page - Int
The default number of products per page in Grid View.
grid_per_page_values - String
A list of numbers that define how many products can be displayed in Grid View.
grouped_product_image - ProductImageThumbnail!
checkout/cart/grouped_product_image: which image to use for grouped products.
head_includes - String
Scripts that must be included in the HTML before the closing `<head>` tag.
head_shortcut_icon - String
The small graphic image (favicon) that appears in the address bar and tab of the browser.
header_logo_src - String
The path to the logo that appears in the header.
id - Int
The ID number assigned to the store. (Deprecated: Use `store_code` instead.)
is_checkout_agreements_enabled - Boolean!
Configuration data from checkout/options/enable_agreements
is_default_store - Boolean
Indicates whether the store view has been designated as the default within the store group.
is_default_store_group - Boolean
Indicates whether the store group has been designated as the default within the website.
is_guest_checkout_enabled - Boolean
checkout/options/guest_checkout: whether the guest checkout is enabled or not.
is_negotiable_quote_active - Boolean
Indicates whether negotiable quote functionality is enabled.
is_one_page_checkout_enabled - Boolean
checkout/options/onepage_checkout_enabled: whether the one page checkout is enabled or not
is_requisition_list_active - String
Indicates whether requisition lists are enabled. Possible values: 1 (Yes) and 0 (No).
list_mode - String
The format of the search results list.
list_per_page - Int
The default number of products per page in List View.
list_per_page_values - String
A list of numbers that define how many products can be displayed in List View.
locale - String
The store locale.
logo_alt - String
The Alt text that is associated with the logo.
logo_height - Int
The height of the logo image, in pixels.
logo_width - Int
The width of the logo image, in pixels.
magento_reward_general_is_enabled - String
Indicates whether reward points functionality is enabled. Possible values: 1 (Enabled) and 0 (Disabled).
magento_reward_general_is_enabled_on_front - String
Indicates whether reward points functionality is enabled on the storefront. Possible values: 1 (Enabled) and 0 (Disabled).
magento_reward_general_min_points_balance - String
The minimum point balance customers must have before they can redeem them. A null value indicates no minimum.
magento_reward_general_publish_history - String
When enabled, customers can see a detailed history of their reward points. Possible values: 1 (Enabled) and 0 (Disabled).
magento_reward_points_invitation_customer - String
The number of points for a referral when an invitee registers on the site.
magento_reward_points_invitation_customer_limit - String
The maximum number of registration referrals that will qualify for rewards. A null value indicates no limit.
magento_reward_points_invitation_order - String
The number of points for a referral, when an invitee places their first order on the site.
magento_reward_points_invitation_order_limit - String
The number of order conversions that can earn points for the customer who sends the invitation. A null value indicates no limit.
magento_reward_points_newsletter - String
The number of points earned by registered customers who subscribe to a newsletter.
magento_reward_points_order - String
Indicates customers earn points for shopping according to the reward point exchange rate. In Luma, this also controls whether to show a message in the shopping cart about the rewards points earned for the purchase, as well as the customer’s current reward point balance.
magento_reward_points_register - String
The number of points customer gets for registering.
magento_reward_points_review - String
The number of points for writing a review.
magento_reward_points_review_limit - String
The maximum number of reviews that will qualify for the rewards. A null value indicates no limit.
magento_wishlist_general_is_enabled - String
Indicates whether wishlists are enabled (1) or disabled (0).
max_items_in_order_summary - Int
checkout/options/max_items_display_count: maximum number of items to display in order summary.
maximum_number_of_wishlists - String
If multiple wish lists are enabled, the maximum number of wish lists the customer can have.
minicart_display - Boolean
checkout/sidebar/display: whether to display the minicart or not.
minicart_max_items - Int
checkout/sidebar/count: maximum number of items to show in minicart.
minimum_password_length - String
The minimum number of characters required for a valid password.
newsletter_enabled - Boolean!
Indicates whether newsletters are enabled.
no_route - String
The default page that displays when a 404 'Page not Found' error occurs.
optional_zip_countries - String
Extended Config Data - general/country/optional_zip_countries
order_cancellation_enabled - Boolean!
Indicates whether orders can be cancelled by customers or not.
order_cancellation_reasons - [CancellationReason]!
An array containing available cancellation reasons.
orders_invoices_credit_memos_display_full_summary - Boolean!
Configuration data from tax/sales_display/full_summary
orders_invoices_credit_memos_display_grandtotal - Boolean!
Configuration data from tax/sales_display/grandtotal
orders_invoices_credit_memos_display_price - Int!
Configuration data from tax/sales_display/price
orders_invoices_credit_memos_display_shipping_amount - Int!
Configuration data from tax/sales_display/shipping
orders_invoices_credit_memos_display_subtotal - Int!
Configuration data from tax/sales_display/subtotal
orders_invoices_credit_memos_display_zero_tax - Boolean!
Configuration data from tax/sales_display/zero_tax
payment_payflowpro_cc_vault_active - String
Payflow Pro vault status.
printed_card_price - String
The default price of a printed card that accompanies an order. (Deprecated: Use printed_card_priceV2 instead)
printed_card_priceV2 - Money
The default price of a printed card that accompanies an order.
product_fixed_product_tax_display_setting - FixedProductTaxDisplaySettings
Corresponds to the 'Display Prices On Product View Page' field in the Admin. It indicates how FPT information is displayed on product pages.
product_reviews_enabled - String
Indicates whether product reviews are enabled. Possible values: 1 (Yes) and 0 (No).
product_url_suffix - String
The suffix applied to product pages, such as `.htm` or `.html`.
quickorder_active - Boolean!
Indicates whether quick order functionality is enabled.
required_character_classes_number - String
The number of different character classes (lowercase, uppercase, digits, special characters) required in a password.
returns_enabled - String!
Indicates whether RMA is enabled on the storefront. Possible values: enabled/disabled.
root_category_id - Int
The ID of the root category. (Deprecated: Use `root_category_uid` instead.)
root_category_uid - ID
The unique ID for a `CategoryInterface` object.
sales_fixed_product_tax_display_setting - FixedProductTaxDisplaySettings
Corresponds to the 'Display Prices In Sales Modules' field in the Admin. It indicates how FPT information is displayed on cart, checkout, and order pages.
sales_gift_wrapping - String
Indicates if gift wrapping prices are displayed on the Orders page. Possible values: 1 (Yes) and 0 (No).
sales_printed_card - String
Indicates if printed card prices are displayed on the Orders page. Possible values: 1 (Yes) and 0 (No).
secure_base_link_url - String
A secure fully-qualified URL that is used to create relative links to the `base_url`.
secure_base_media_url - String
The secure fully-qualified URL that specifies the location of media files.
secure_base_static_url - String
The secure fully-qualified URL that specifies the location of static view files.
secure_base_url - String
The store’s fully-qualified secure base URL.
send_friend - SendFriendConfiguration
Email to a Friend configuration.
share_active_segments - Boolean
Configuration data from customer/magento_customersegment/share_active_segments
share_applied_cart_rule - Boolean
Configuration data from promo/graphql/share_applied_cart_rule
shopping_cart_display_full_summary - Boolean
Extended Config Data - tax/cart_display/full_summary
shopping_cart_display_grand_total - Boolean
Extended Config Data - tax/cart_display/grandtotal
shopping_cart_display_price - Int
Extended Config Data - tax/cart_display/price
shopping_cart_display_shipping - Int
Extended Config Data - tax/cart_display/shipping
shopping_cart_display_subtotal - Int
Extended Config Data - tax/cart_display/subtotal
shopping_cart_display_tax_gift_wrapping - TaxWrappingEnum
Extended Config Data - tax/cart_display/gift_wrapping
shopping_cart_display_zero_tax - Boolean
Extended Config Data - tax/cart_display/zero_tax
show_cms_breadcrumbs - Int
Indicates whether a breadcrumb trail appears on all CMS pages in the catalog. 0 (No) or 1 (Yes).
store_code - ID
The unique ID of the store view. In the Admin, this is called the Store View Code. When making a GraphQL call, assign this value to the `Store` header to provide the scope.
store_group_code - ID
The unique ID assigned to the store group. In the Admin, this is called the Store Name.
store_group_name - String
The label assigned to the store group.
store_name - String
The label assigned to the store view.
store_sort_order - Int
The store view sort order.
timezone - String
The time zone of the store.
title_prefix - String
A prefix that appears before the title to create a two- or three-part title.
title_separator - String
The character that separates the category name and subcategory in the browser title bar.
title_suffix - String
A suffix that appears after the title to create a two- or three-part title.
use_store_in_url - Boolean
Indicates whether the store code should be used in the URL.
website_code - ID
The unique ID for the website.
website_id - Int
The ID number assigned to the website store. (Deprecated: The field should not be used on the storefront.)
website_name - String
The label assigned to the website.
weight_unit - String
The unit of weight.
welcome - String
Text that appears in the header of the page and includes the name of the logged in customer.
zero_subtotal_enable_for_specific_countries - Boolean
Indicates whether only specific countries can use this payment method.
zero_subtotal_enabled - Boolean
Indicates whether the Zero Subtotal payment method is enabled.
zero_subtotal_new_order_status - String
The status of new orders placed using the Zero Subtotal payment method.
zero_subtotal_payment_action - String
When the new order status is 'Processing', this can be set to `authorize_capture` to automatically invoice all items that have a zero balance.
zero_subtotal_payment_from_specific_countries - String
A comma-separated list of specific countries allowed to use the Zero Subtotal payment method.
zero_subtotal_sort_order - Int
A number indicating the position of the Zero Subtotal payment method in the list of available payment methods during checkout.
zero_subtotal_title - String
The title of the Zero Subtotal payment method displayed on the storefront.

Example

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

StorefrontProperties

Indicates where an attribute can be displayed.

Fields

Field NameDescription
position - Int
The relative position of the attribute in the layered navigation block.
use_in_layered_navigation - UseInLayeredNavigationOptions
Indicates whether the attribute is filterable with results, without results, or not at all.
use_in_product_listing - Boolean
Indicates whether the attribute is displayed in product listings.
use_in_search_results_layered_navigation - Boolean
Indicates whether the attribute can be used in layered navigation on search results pages.
visible_on_catalog_pages - Boolean
Indicates whether the attribute is displayed on product pages.

Example

Copied to your clipboard
{
  "position": 123,
  "use_in_layered_navigation": "NO",
  "use_in_product_listing": false,
  "use_in_search_results_layered_navigation": false,
  "visible_on_catalog_pages": true
}

String

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Example

Copied to your clipboard
"xyz789"

SubmitNegotiableQuoteTemplateForReviewInput

Specifies the quote template properties to update.

Input Fields

Input FieldDescription
comment - String
A comment for the seller to review.
max_order_commitment - Int
Commitment for maximum orders
min_order_commitment - Int
Commitment for minimum orders
name - String
The title assigned to the negotiable quote template.
reference_document_links - [NegotiableQuoteTemplateReferenceDocumentLinkInput]
An array of reference document links to add to the negotiable quote template.
template_id - ID!
The unique ID of a `NegotiableQuoteTemplate` object.

Example

Copied to your clipboard
{
  "comment": "abc123",
  "max_order_commitment": 987,
  "min_order_commitment": 987,
  "name": "abc123",
  "reference_document_links": [
    NegotiableQuoteTemplateReferenceDocumentLinkInput
  ],
  "template_id": "4"
}

SubscribeEmailToNewsletterOutput

Contains the result of the subscribeEmailToNewsletter operation.

Fields

Field NameDescription
status - SubscriptionStatusesEnum
The status of the subscription request.

Example

Copied to your clipboard
{"status": "NOT_ACTIVE"}

SubscriptionStatusesEnum

Indicates the status of the request.

Values

Enum ValueDescription
NOT_ACTIVE
SUBSCRIBED
UNSUBSCRIBED
UNCONFIRMED

Example

Copied to your clipboard
""NOT_ACTIVE""

SwatchData

Describes the swatch type and a value.

Fields

Field NameDescription
type - String
The type of swatch filter item: 1 - text; 2 - image.
value - String
The value for the swatch item. It could be text or an image link.

Example

Copied to your clipboard
{
  "type": "xyz789",
  "value": "abc123"
}

SwatchDataInterface

Fields

Field NameDescription
value - String
The value can be represented as color (HEX code), image link, or text.

Possible Types

SwatchDataInterface Types
ImageSwatchData
TextSwatchData
ColorSwatchData

Example

Copied to your clipboard
{"value": "xyz789"}

SwatchInputTypeEnum

Swatch attribute metadata input types.

Values

Enum ValueDescription
BOOLEAN
DATE
DATETIME
DROPDOWN
FILE
GALLERY
HIDDEN
IMAGE
MEDIA_IMAGE
MULTILINE
MULTISELECT
PRICE
SELECT
TEXT
TEXTAREA
UNDEFINED
VISUAL
WEIGHT

Example

Copied to your clipboard
""BOOLEAN""

SwatchLayerFilterItem

Fields

Field NameDescription
items_count - Int
The count of items per filter. (Deprecated: Use `AggregationOption.count` instead.)
label - String
The label for a filter. (Deprecated: Use `AggregationOption.label` instead.)
swatch_data - SwatchData
Data required to render a swatch filter item.
value_string - String
The value of a filter request variable to be used in query. (Deprecated: Use `AggregationOption.value` instead.)

Example

Copied to your clipboard
{
  "items_count": 987,
  "label": "xyz789",
  "swatch_data": SwatchData,
  "value_string": "xyz789"
}

SwatchLayerFilterItemInterface

Fields

Field NameDescription
swatch_data - SwatchData
Data required to render a swatch filter item.

Possible Types

SwatchLayerFilterItemInterface Types
SwatchLayerFilterItem

Example

Copied to your clipboard
{"swatch_data": SwatchData}

SyncPaymentOrderInput

Synchronizes the payment order details

Input Fields

Input FieldDescription
cartId - String!
The customer cart ID
id - String!
PayPal order ID

Example

Copied to your clipboard
{
  "cartId": "abc123",
  "id": "xyz789"
}

TaxItem

Contains tax item details.

Fields

Field NameDescription
amount - Money!
The amount of tax applied to the item.
rate - Float!
The rate used to calculate the tax.
title - String!
A title that describes the tax.

Example

Copied to your clipboard
{
  "amount": Money,
  "rate": 123.45,
  "title": "xyz789"
}

TaxWrappingEnum

Values

Enum ValueDescription
DISPLAY_EXCLUDING_TAX
DISPLAY_INCLUDING_TAX
DISPLAY_TYPE_BOTH

Example

Copied to your clipboard
""DISPLAY_EXCLUDING_TAX""

TextSwatchData

Fields

Field NameDescription
value - String
The value can be represented as color (HEX code), image link, or text.

Example

Copied to your clipboard
{"value": "abc123"}

ThreeDSMode

3D Secure mode.

Values

Enum ValueDescription
OFF
SCA_WHEN_REQUIRED
SCA_ALWAYS

Example

Copied to your clipboard
""OFF""

TierPrice

Defines a price based on the quantity purchased.

Fields

Field NameDescription
discount - ProductDiscount
The price discount that this tier represents.
final_price - Money
The price of the product at this tier.
quantity - Float
The minimum number of items that must be purchased to qualify for this price tier.

Example

Copied to your clipboard
{
  "discount": ProductDiscount,
  "final_price": Money,
  "quantity": 987.65
}

UpdateCartItemsInput

Modifies the specified items in the cart.

Input Fields

Input FieldDescription
cart_id - String!
The unique ID of a `Cart` object.
cart_items - [CartItemUpdateInput]!
An array of items to be updated.

Example

Copied to your clipboard
{
  "cart_id": "xyz789",
  "cart_items": [CartItemUpdateInput]
}

UpdateCartItemsOutput

Contains details about the cart after updating items.

Fields

Field NameDescription
cart - Cart!
The cart after updating products.
errors - [CartUserInputError]!
Contains errors encountered while updating an item to the cart.

Example

Copied to your clipboard
{
  "cart": Cart,
  "errors": [CartUserInputError]
}

UpdateCompanyOutput

Contains the response to the request to update the company.

Fields

Field NameDescription
company - Company!
The updated company instance.

Example

Copied to your clipboard
{"company": Company}

UpdateCompanyRoleOutput

Contains the response to the request to update the company role.

Fields

Field NameDescription
role - CompanyRole!
The updated company role instance.

Example

Copied to your clipboard
{"role": CompanyRole}

UpdateCompanyStructureOutput

Contains the response to the request to update the company structure.

Fields

Field NameDescription
company - Company!
The updated company instance.

Example

Copied to your clipboard
{"company": Company}

UpdateCompanyTeamOutput

Contains the response to the request to update a company team.

Fields

Field NameDescription
team - CompanyTeam!
The updated company team instance.

Example

Copied to your clipboard
{"team": CompanyTeam}

UpdateCompanyUserOutput

Contains the response to the request to update the company user.

Fields

Field NameDescription
user - Customer!
The updated company user instance.

Example

Copied to your clipboard
{"user": Customer}

UpdateGiftRegistryInput

Defines updates to a GiftRegistry object.

Input Fields

Input FieldDescription
dynamic_attributes - [GiftRegistryDynamicAttributeInput]
Additional attributes specified as a code-value pair. Unspecified dynamic attributes are not changed.
event_name - String
The updated name of the event.
message - String
The updated message describing the event.
privacy_settings - GiftRegistryPrivacySettings
Indicates whether the gift registry is PRIVATE or PUBLIC.
shipping_address - GiftRegistryShippingAddressInput
The updated shipping address for all gift registry items.
status - GiftRegistryStatus
Indicates whether the gift registry is ACTIVE or INACTIVE.

Example

Copied to your clipboard
{
  "dynamic_attributes": [
    GiftRegistryDynamicAttributeInput
  ],
  "event_name": "abc123",
  "message": "xyz789",
  "privacy_settings": "PRIVATE",
  "shipping_address": GiftRegistryShippingAddressInput,
  "status": "ACTIVE"
}

UpdateGiftRegistryItemInput

Defines updates to an item in a gift registry.

Input Fields

Input FieldDescription
gift_registry_item_uid - ID!
The unique ID of a `giftRegistryItem` object.
note - String
The updated description of the item.
quantity - Float!
The updated quantity of the gift registry item.

Example

Copied to your clipboard
{
  "gift_registry_item_uid": "4",
  "note": "xyz789",
  "quantity": 987.65
}

UpdateGiftRegistryItemsOutput

Contains the results of a request to update gift registry items.

Fields

Field NameDescription
gift_registry - GiftRegistry
The gift registry after updating updating items.

Example

Copied to your clipboard
{"gift_registry": GiftRegistry}

UpdateGiftRegistryOutput

Contains the results of a request to update a gift registry.

Fields

Field NameDescription
gift_registry - GiftRegistry
The updated gift registry.

Example

Copied to your clipboard
{"gift_registry": GiftRegistry}

UpdateGiftRegistryRegistrantInput

Defines updates to an existing registrant.

Input Fields

Input FieldDescription
dynamic_attributes - [GiftRegistryDynamicAttributeInput]
As a result of the update, only the values of provided attributes will be affected. If the attribute is missing in the request, its value will not be changed.
email - String
The updated email address of the registrant.
firstname - String
The updated first name of the registrant.
gift_registry_registrant_uid - ID!
The unique ID of a `giftRegistryRegistrant` object.
lastname - String
The updated last name of the registrant.

Example

Copied to your clipboard
{
  "dynamic_attributes": [
    GiftRegistryDynamicAttributeInput
  ],
  "email": "abc123",
  "firstname": "xyz789",
  "gift_registry_registrant_uid": "4",
  "lastname": "abc123"
}

UpdateGiftRegistryRegistrantsOutput

Contains the results a request to update registrants.

Fields

Field NameDescription
gift_registry - GiftRegistry
The gift registry after updating registrants.

Example

Copied to your clipboard
{"gift_registry": GiftRegistry}

UpdateNegotiableQuoteItemsQuantityOutput

Contains the updated negotiable quote.

Fields

Field NameDescription
quote - NegotiableQuote
The updated negotiable quote.

Example

Copied to your clipboard
{"quote": NegotiableQuote}

UpdateNegotiableQuoteQuantitiesInput

Specifies the items to update.

Input Fields

Input FieldDescription
items - [NegotiableQuoteItemQuantityInput]!
An array of items to update.
quote_uid - ID!
The unique ID of a `NegotiableQuote` object.

Example

Copied to your clipboard
{
  "items": [NegotiableQuoteItemQuantityInput],
  "quote_uid": 4
}

UpdateNegotiableQuoteTemplateItemsQuantityOutput

Contains the updated negotiable quote template.

Fields

Field NameDescription
quote_template - NegotiableQuoteTemplate
The updated negotiable quote template.

Example

Copied to your clipboard
{"quote_template": NegotiableQuoteTemplate}

UpdateNegotiableQuoteTemplateQuantitiesInput

Specifies the items to update.

Input Fields

Input FieldDescription
items - [NegotiableQuoteTemplateItemQuantityInput]!
An array of items to update.
template_id - ID!
The unique ID of a `NegotiableQuoteTemplate` object.

Example

Copied to your clipboard
{
  "items": [NegotiableQuoteTemplateItemQuantityInput],
  "template_id": 4
}

UpdateProductsInWishlistOutput

Contains the customer's wish list and any errors encountered.

Fields

Field NameDescription
user_errors - [WishListUserInputError]!
An array of errors encountered while updating products in a wish list.
wishlist - Wishlist!
Contains the wish list with all items that were successfully updated.

Example

Copied to your clipboard
{
  "user_errors": [WishListUserInputError],
  "wishlist": Wishlist
}

UpdatePurchaseOrderApprovalRuleInput

Defines the changes to be made to an approval rule.

Input Fields

Input FieldDescription
applies_to - [ID]
An updated list of company user role IDs to which this purchase order approval rule should be applied. When an empty array is provided, the rule is applied to all user roles in the system, including those created in the future.
approvers - [ID]
An updated list of B2B user roles that can approve this purchase order approval rule.
condition - CreatePurchaseOrderApprovalRuleConditionInput
The updated condition of the purchase order approval rule.
description - String
The updated approval rule description.
name - String
The updated approval rule name.
status - PurchaseOrderApprovalRuleStatus
The updated status of the purchase order approval rule.
uid - ID!
Unique identifier for the purchase order approval rule.

Example

Copied to your clipboard
{
  "applies_to": ["4"],
  "approvers": [4],
  "condition": CreatePurchaseOrderApprovalRuleConditionInput,
  "description": "abc123",
  "name": "xyz789",
  "status": "ENABLED",
  "uid": 4
}

UpdateRequisitionListInput

An input object that defines which requistion list characteristics to update.

Input Fields

Input FieldDescription
description - String
The updated description of the requisition list.
name - String!
The new name of the requisition list.

Example

Copied to your clipboard
{
  "description": "xyz789",
  "name": "xyz789"
}

UpdateRequisitionListItemsInput

Defines which items in a requisition list to update.

Input Fields

Input FieldDescription
entered_options - [EnteredOptionInput]
An array of customer-entered options.
item_id - ID!
The ID of the requisition list item to update.
quantity - Float
The new quantity of the item.
selected_options - [String]
An array of selected option IDs.

Example

Copied to your clipboard
{
  "entered_options": [EnteredOptionInput],
  "item_id": "4",
  "quantity": 123.45,
  "selected_options": ["abc123"]
}

UpdateRequisitionListItemsOutput

Output of the request to update items in the specified requisition list.

Fields

Field NameDescription
requisition_list - RequisitionList
The requisition list after updating items.

Example

Copied to your clipboard
{"requisition_list": RequisitionList}

UpdateRequisitionListOutput

Output of the request to rename the requisition list.

Fields

Field NameDescription
requisition_list - RequisitionList
The renamed requisition list.

Example

Copied to your clipboard
{"requisition_list": RequisitionList}

UpdateWishlistOutput

Contains the name and visibility of an updated wish list.

Fields

Field NameDescription
name - String!
The wish list name.
uid - ID!
The unique ID of a `Wishlist` object.
visibility - WishlistVisibilityEnum!
Indicates whether the wish list is public or private.

Example

Copied to your clipboard
{
  "name": "xyz789",
  "uid": "4",
  "visibility": "PUBLIC"
}

UrlRewrite

Contains URL rewrite details.

Fields

Field NameDescription
parameters - [HttpQueryParameter]
An array of request parameters.
url - String
The request URL.

Example

Copied to your clipboard
{
  "parameters": [HttpQueryParameter],
  "url": "xyz789"
}

UrlRewriteEntityTypeEnum

This enumeration defines the entity type.

Values

Enum ValueDescription
CMS_PAGE
PRODUCT
CATEGORY

Example

Copied to your clipboard
""CMS_PAGE""

UseInLayeredNavigationOptions

Defines whether the attribute is filterable in layered navigation.

Values

Enum ValueDescription
NO
FILTERABLE_WITH_RESULTS
FILTERABLE_NO_RESULT

Example

Copied to your clipboard
""NO""

UserCompaniesInput

Defines the input for returning matching companies the customer is assigned to.

Input Fields

Input FieldDescription
currentPage - Int
Specifies which page of results to return. The default value is 1.
pageSize - Int
Specifies the maximum number of results to return at once. This attribute is optional.
sort - [CompaniesSortInput]
Defines the sorting of the results.

Example

Copied to your clipboard
{
  "currentPage": 987,
  "pageSize": 123,
  "sort": [CompaniesSortInput]
}

UserCompaniesOutput

An object that contains a list of companies customer is assigned to.

Fields

Field NameDescription
items - [CompanyBasicInfo]!
An array of companies customer is assigned to.
page_info - SearchResultPageInfo!
Provides navigation for the query response.

Example

Copied to your clipboard
{
  "items": [CompanyBasicInfo],
  "page_info": SearchResultPageInfo
}

ValidatePurchaseOrderError

Contains details about a failed validation attempt.

Fields

Field NameDescription
message - String!
The returned error message.
type - ValidatePurchaseOrderErrorType!
Error type.

Example

Copied to your clipboard
{"message": "xyz789", "type": "NOT_FOUND"}

ValidatePurchaseOrderErrorType

Values

Enum ValueDescription
NOT_FOUND
OPERATION_NOT_APPLICABLE
COULD_NOT_SAVE
NOT_VALID_DATA
UNDEFINED

Example

Copied to your clipboard
""NOT_FOUND""

ValidatePurchaseOrdersInput

Defines the purchase orders to be validated.

Input Fields

Input FieldDescription
purchase_order_uids - [ID]!
An array of the purchase order IDs.

Example

Copied to your clipboard
{"purchase_order_uids": ["4"]}

ValidatePurchaseOrdersOutput

Contains the results of validation attempts.

Fields

Field NameDescription
errors - [ValidatePurchaseOrderError]!
An array of error messages encountered while performing the operation.
purchase_orders - [PurchaseOrder]!
An array of the purchase orders in the request.

Example

Copied to your clipboard
{
  "errors": [ValidatePurchaseOrderError],
  "purchase_orders": [PurchaseOrder]
}

ValidationRule

Defines a customer attribute validation rule.

Fields

Field NameDescription
name - ValidationRuleEnum
Validation rule name applied to a customer attribute.
value - String
Validation rule value.

Example

Copied to your clipboard
{
  "name": "DATE_RANGE_MAX",
  "value": "abc123"
}

ValidationRuleEnum

List of validation rule names applied to a customer attribute.

Values

Enum ValueDescription
DATE_RANGE_MAX
DATE_RANGE_MIN
FILE_EXTENSIONS
INPUT_VALIDATION
MAX_TEXT_LENGTH
MIN_TEXT_LENGTH
MAX_FILE_SIZE
MAX_IMAGE_HEIGHT
MAX_IMAGE_WIDTH

Example

Copied to your clipboard
""DATE_RANGE_MAX""

VaultConfigOutput

Retrieves the vault configuration

Fields

Field NameDescription
credit_card - VaultCreditCardConfig
Credit card vault method configuration

Example

Copied to your clipboard
{"credit_card": VaultCreditCardConfig}

VaultCreditCardConfig

Fields

Field NameDescription
is_vault_enabled - Boolean
Is vault enabled
sdk_params - [SDKParams]
The parameters required to load the Paypal JS SDK
three_ds_mode - ThreeDSMode
3DS mode

Example

Copied to your clipboard
{
  "is_vault_enabled": false,
  "sdk_params": [SDKParams],
  "three_ds_mode": "OFF"
}

VaultMethodInput

Vault payment inputs

Input Fields

Input FieldDescription
payment_source - String
The payment source for the payment method
payments_order_id - String
The payment services order ID
paypal_order_id - String
PayPal order ID
public_hash - String
The public hash of the token.

Example

Copied to your clipboard
{
  "payment_source": "xyz789",
  "payments_order_id": "abc123",
  "paypal_order_id": "abc123",
  "public_hash": "xyz789"
}

VaultSetupTokenInput

The payment source information

Input Fields

Input FieldDescription
payment_source - PaymentSourceInput!
The payment source information

Example

Copied to your clipboard
{"payment_source": PaymentSourceInput}

VaultTokenInput

Contains required input for payment methods with Vault support.

Input Fields

Input FieldDescription
public_hash - String!
The public hash of the payment token.

Example

Copied to your clipboard
{"public_hash": "abc123"}

VirtualCartItem

An implementation for virtual product cart items.

Fields

Field NameDescription
customizable_options - [SelectedCustomizableOption]!
An array containing customizable options the shopper selected.
discount - [Discount]
Contains discount for quote line item.
errors - [CartItemError]
An array of errors encountered while loading the cart item
id - String!
(Deprecated: Use `uid` instead.)
is_available - Boolean!
True if requested quantity is less than available stock, false otherwise.
max_qty - Float
Line item max qty in quote template
min_qty - Float
Line item min qty in quote template
not_available_message - String
Message to display when the product is not available with this selected option.
note_from_buyer - [ItemNote]
The buyer's quote line item note.
note_from_seller - [ItemNote]
The seller's quote line item note.
prices - CartItemPrices
Contains details about the price of the item, including taxes and discounts.
product - ProductInterface!
Details about an item in the cart.
quantity - Float!
The quantity of this item in the cart.
uid - ID!
The unique ID for a `CartItemInterface` object.

Example

Copied to your clipboard
{
  "customizable_options": [SelectedCustomizableOption],
  "discount": [Discount],
  "errors": [CartItemError],
  "id": "xyz789",
  "is_available": true,
  "max_qty": 123.45,
  "min_qty": 987.65,
  "not_available_message": "abc123",
  "note_from_buyer": [ItemNote],
  "note_from_seller": [ItemNote],
  "prices": CartItemPrices,
  "product": ProductInterface,
  "quantity": 123.45,
  "uid": "4"
}

VirtualProduct

Defines a virtual product, which is a non-tangible product that does not require shipping and is not kept in inventory.

Fields

Field NameDescription
attribute_set_id - Int
The attribute set assigned to the product. (Deprecated: The field should not be used on the storefront.)
canonical_url - String
The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.
categories - [CategoryInterface]
The categories assigned to a product.
color - Int
(Deprecated: Use the `custom_attributes` field instead.)
country_of_manufacture - String
The product's country of origin.
created_at - String
Timestamp indicating when the product was created. (Deprecated: The field should not be used on the storefront.)
crosssell_products - [ProductInterface]
An array of cross-sell products.
custom_attributesV2 - ProductCustomAttributes
Product custom attributes.
description - ComplexTextValue
Detailed information about the product. The value can include simple HTML tags.
gift_message_available - Boolean!
Returns a value indicating gift message availability for the product.
gift_wrapping_available - Boolean!
Returns a value indicating gift wrapping availability for the product.
gift_wrapping_price - Money
Returns value and currency indicating gift wrapping price for the product.
id - Int
The ID number assigned to the product. (Deprecated: Use the `uid` field instead.)
image - ProductImage
The relative path to the main image on the product page.
is_returnable - String
Indicates whether the product can be returned.
manufacturer - Int
A number representing the product's manufacturer. (Deprecated: Use the `custom_attributes` field instead.)
max_sale_qty - Float
Maximum Qty Allowed in Shopping Cart
media_gallery - [MediaGalleryInterface]
An array of media gallery objects.
media_gallery_entries - [MediaGalleryEntry]
An array of MediaGalleryEntry objects. (Deprecated: Use `media_gallery` instead.)
meta_description - String
A brief overview of the product for search results listings, maximum 255 characters.
meta_keyword - String
A comma-separated list of keywords that are visible only to search engines.
meta_title - String
A string that is displayed in the title bar and tab of the browser and in search results lists.
min_sale_qty - Float
Minimum Qty Allowed in Shopping Cart
name - String
The product name. Customers use this name to identify the product.
new_from_date - String
The beginning date for new product listings, and determines if the product is featured as a new product.
new_to_date - String
The end date for new product listings.
only_x_left_in_stock - Float
Product stock only x left count
options - [CustomizableOptionInterface]
An array of options for a customizable product.
options_container - String
If the product has multiple options, determines where they appear on the product page.
price - ProductPrices
Indicates the price of an item. (Deprecated: Use `price_range` for product price information.)
price_range - PriceRange!
The range of prices for the product
price_tiers - [TierPrice]
An array of `TierPrice` objects.
product_links - [ProductLinksInterface]
An array of `ProductLinks` objects.
quantity - Float
Amount of available stock
rating_summary - Float!
The average of all the ratings given to the product.
redirect_code - Int!
Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.
related_products - [ProductInterface]
An array of related products.
relative_url - String
The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.
review_count - Int!
The total count of all the reviews given to the product.
reviews - ProductReviews!
The list of products reviews.
short_description - ComplexTextValue
A short description of the product. Its use depends on the theme.
sku - String
A number or code assigned to a product to identify the product, options, price, and manufacturer.
small_image - ProductImage
The relative path to the small image, which is used on catalog pages.
special_from_date - String
The beginning date that a product has a special price. (Deprecated: The field should not be used on the storefront.)
special_price - Float
The discounted price of the product.
special_to_date - String
The end date for a product with a special price.
staged - Boolean!
Indicates whether the product is staged for a future campaign.
stock_status - ProductStockStatus
Stock status of the product
swatch_image - String
The file name of a swatch image.
thumbnail - ProductImage
The relative path to the product's thumbnail image.
tier_price - Float
The price when tier pricing is in effect and the items purchased threshold has been reached. (Deprecated: Use `price_tiers` for product tier price information.)
tier_prices - [ProductTierPrices]
An array of ProductTierPrices objects. (Deprecated: Use `price_tiers` for product tier price information.)
type - UrlRewriteEntityTypeEnum
One of PRODUCT, CATEGORY, or CMS_PAGE.
type_id - String
One of simple, virtual, bundle, downloadable, grouped, or configurable. (Deprecated: Use `__typename` instead.)
uid - ID!
The unique ID for a `ProductInterface` object.
updated_at - String
Timestamp indicating when the product was updated. (Deprecated: The field should not be used on the storefront.)
upsell_products - [ProductInterface]
An array of up-sell products.
url_key - String
The part of the URL that identifies the product
url_path - String
(Deprecated: Use product's `canonical_url` or url rewrites instead)
url_rewrites - [UrlRewrite]
URL rewrites list
url_suffix - String
The part of the product URL that is appended after the url key
websites - [Website]
An array of websites in which the product is available. (Deprecated: The field should not be used on the storefront.)

Example

Copied to your clipboard
{
  "attribute_set_id": 123,
  "canonical_url": "abc123",
  "categories": [CategoryInterface],
  "color": 987,
  "country_of_manufacture": "abc123",
  "created_at": "xyz789",
  "crosssell_products": [ProductInterface],
  "custom_attributesV2": ProductCustomAttributes,
  "description": ComplexTextValue,
  "gift_message_available": false,
  "gift_wrapping_available": false,
  "gift_wrapping_price": Money,
  "id": 123,
  "image": ProductImage,
  "is_returnable": "xyz789",
  "manufacturer": 123,
  "max_sale_qty": 123.45,
  "media_gallery": [MediaGalleryInterface],
  "media_gallery_entries": [MediaGalleryEntry],
  "meta_description": "xyz789",
  "meta_keyword": "xyz789",
  "meta_title": "abc123",
  "min_sale_qty": 987.65,
  "name": "xyz789",
  "new_from_date": "abc123",
  "new_to_date": "abc123",
  "only_x_left_in_stock": 987.65,
  "options": [CustomizableOptionInterface],
  "options_container": "abc123",
  "price": ProductPrices,
  "price_range": PriceRange,
  "price_tiers": [TierPrice],
  "product_links": [ProductLinksInterface],
  "quantity": 123.45,
  "rating_summary": 123.45,
  "redirect_code": 123,
  "related_products": [ProductInterface],
  "relative_url": "abc123",
  "review_count": 987,
  "reviews": ProductReviews,
  "short_description": ComplexTextValue,
  "sku": "xyz789",
  "small_image": ProductImage,
  "special_from_date": "abc123",
  "special_price": 123.45,
  "special_to_date": "xyz789",
  "staged": true,
  "stock_status": "IN_STOCK",
  "swatch_image": "xyz789",
  "thumbnail": ProductImage,
  "tier_price": 987.65,
  "tier_prices": [ProductTierPrices],
  "type": "CMS_PAGE",
  "type_id": "xyz789",
  "uid": 4,
  "updated_at": "xyz789",
  "upsell_products": [ProductInterface],
  "url_key": "xyz789",
  "url_path": "abc123",
  "url_rewrites": [UrlRewrite],
  "url_suffix": "xyz789",
  "websites": [Website]
}

VirtualProductCartItemInput

Defines a single product to add to the cart.

Input Fields

Input FieldDescription
customizable_options - [CustomizableOptionInput]
An array that defines customizable options for the product.
data - CartItemInput!
An object containing the `sku`, `quantity`, and other relevant information about the product.

Example

Copied to your clipboard
{
  "customizable_options": [CustomizableOptionInput],
  "data": CartItemInput
}

VirtualRequisitionListItem

Contains details about virtual products added to a requisition list.

Fields

Field NameDescription
customizable_options - [SelectedCustomizableOption]!
Selected custom options for an item in the requisition list.
product - ProductInterface!
Details about a requisition list item.
quantity - Float!
The amount added.
uid - ID!
The unique ID for the requisition list item.

Example

Copied to your clipboard
{
  "customizable_options": [SelectedCustomizableOption],
  "product": ProductInterface,
  "quantity": 123.45,
  "uid": "4"
}

VirtualWishlistItem

Contains a virtual product wish list item.

Fields

Field NameDescription
added_at - String!
The date and time the item was added to the wish list.
customizable_options - [SelectedCustomizableOption]!
Custom options selected for the wish list item.
description - String
The description of the item.
id - ID!
The unique ID for a `WishlistItemInterface` object.
product - ProductInterface
Product details of the wish list item.
quantity - Float!
The quantity of this wish list item.

Example

Copied to your clipboard
{
  "added_at": "abc123",
  "customizable_options": [SelectedCustomizableOption],
  "description": "abc123",
  "id": 4,
  "product": ProductInterface,
  "quantity": 123.45
}

Website

Deprecated. It should not be used on the storefront. Contains information about a website.

Fields

Field NameDescription
code - String
A code assigned to the website to identify it. (Deprecated: The field should not be used on the storefront.)
default_group_id - String
The default group ID of the website. (Deprecated: The field should not be used on the storefront.)
id - Int
The ID number assigned to the website. (Deprecated: The field should not be used on the storefront.)
is_default - Boolean
Indicates whether this is the default website. (Deprecated: The field should not be used on the storefront.)
name - String
The website name. Websites use this name to identify it easier. (Deprecated: The field should not be used on the storefront.)
sort_order - Int
The attribute to use for sorting websites. (Deprecated: The field should not be used on the storefront.)

Example

Copied to your clipboard
{
  "code": "xyz789",
  "default_group_id": "abc123",
  "id": 987,
  "is_default": true,
  "name": "xyz789",
  "sort_order": 987
}

WishListUserInputError

An error encountered while performing operations with WishList.

Fields

Field NameDescription
code - WishListUserInputErrorType!
A wish list-specific error code.
message - String!
A localized error message.

Example

Copied to your clipboard
{
  "code": "PRODUCT_NOT_FOUND",
  "message": "abc123"
}

WishListUserInputErrorType

A list of possible error types.

Values

Enum ValueDescription
PRODUCT_NOT_FOUND
UNDEFINED

Example

Copied to your clipboard
""PRODUCT_NOT_FOUND""

Wishlist

Contains a customer wish list.

Fields

Field NameDescription
id - ID
The unique ID for a `Wishlist` object.
items - [WishlistItem]
(Deprecated: Use the `items_v2` field instead.)
items_count - Int
The number of items in the wish list.
items_v2 - WishlistItems
An array of items in the customer's wish list.
name - String
The name of the wish list.
sharing_code - String
An encrypted code that Magento uses to link to the wish list.
updated_at - String
The time of the last modification to the wish list.
visibility - WishlistVisibilityEnum!
Indicates whether the wish list is public or private.

Example

Copied to your clipboard
{
  "id": 4,
  "items": [WishlistItem],
  "items_count": 987,
  "items_v2": WishlistItems,
  "name": "xyz789",
  "sharing_code": "abc123",
  "updated_at": "xyz789",
  "visibility": "PUBLIC"
}

WishlistCartUserInputError

Contains details about errors encountered when a customer added wish list items to the cart.

Fields

Field NameDescription
code - WishlistCartUserInputErrorType!
An error code that describes the error encountered.
message - String!
A localized error message.
wishlistId - ID!
The unique ID of the `Wishlist` object containing an error.
wishlistItemId - ID!
The unique ID of the wish list item containing an error.

Example

Copied to your clipboard
{
  "code": "PRODUCT_NOT_FOUND",
  "message": "xyz789",
  "wishlistId": 4,
  "wishlistItemId": "4"
}

WishlistCartUserInputErrorType

A list of possible error types.

Values

Enum ValueDescription
PRODUCT_NOT_FOUND
REQUIRED_PARAMETER_MISSING
NOT_SALABLE
INSUFFICIENT_STOCK
UNDEFINED

Example

Copied to your clipboard
""PRODUCT_NOT_FOUND""

WishlistItem

Contains details about a wish list item.

Fields

Field NameDescription
added_at - String
The time when the customer added the item to the wish list.
description - String
The customer's comment about this item.
id - Int
The unique ID for a `WishlistItem` object.
product - ProductInterface
Details about the wish list item.
qty - Float
The quantity of this wish list item

Example

Copied to your clipboard
{
  "added_at": "xyz789",
  "description": "xyz789",
  "id": 987,
  "product": ProductInterface,
  "qty": 987.65
}

WishlistItemCopyInput

Specifies the IDs of items to copy and their quantities.

Input Fields

Input FieldDescription
quantity - Float
The quantity of this item to copy to the destination wish list. This value can't be greater than the quantity in the source wish list.
wishlist_item_id - ID!
The unique ID of the `WishlistItemInterface` object to be copied.

Example

Copied to your clipboard
{
  "quantity": 123.45,
  "wishlist_item_id": "4"
}

WishlistItemInput

Defines the items to add to a wish list.

Input Fields

Input FieldDescription
entered_options - [EnteredOptionInput]
An array of options that the customer entered.
parent_sku - String
For complex product types, the SKU of the parent product.
quantity - Float!
The amount or number of items to add.
selected_options - [ID]
An array of strings corresponding to options the customer selected.
sku - String!
The SKU of the product to add. For complex product types, specify the child product SKU.

Example

Copied to your clipboard
{
  "entered_options": [EnteredOptionInput],
  "parent_sku": "xyz789",
  "quantity": 123.45,
  "selected_options": [4],
  "sku": "xyz789"
}

WishlistItemInterface

The interface for wish list items.

Fields

Field NameDescription
added_at - String!
The date and time the item was added to the wish list.
customizable_options - [SelectedCustomizableOption]!
Custom options selected for the wish list item.
description - String
The description of the item.
id - ID!
The unique ID for a `WishlistItemInterface` object.
product - ProductInterface
Product details of the wish list item.
quantity - Float!
The quantity of this wish list item.

Possible Types

WishlistItemInterface Types
SimpleWishlistItem
VirtualWishlistItem
ConfigurableWishlistItem
DownloadableWishlistItem
BundleWishlistItem
GiftCardWishlistItem
GroupedProductWishlistItem

Example

Copied to your clipboard
{
  "added_at": "xyz789",
  "customizable_options": [SelectedCustomizableOption],
  "description": "xyz789",
  "id": 4,
  "product": ProductInterface,
  "quantity": 123.45
}

WishlistItemMoveInput

Specifies the IDs of the items to move and their quantities.

Input Fields

Input FieldDescription
quantity - Float
The quantity of this item to move to the destination wish list. This value can't be greater than the quantity in the source wish list.
wishlist_item_id - ID!
The unique ID of the `WishlistItemInterface` object to be moved.

Example

Copied to your clipboard
{
  "quantity": 987.65,
  "wishlist_item_id": "4"
}

WishlistItemUpdateInput

Defines updates to items in a wish list.

Input Fields

Input FieldDescription
description - String
Customer-entered comments about the item.
entered_options - [EnteredOptionInput]
An array of options that the customer entered.
quantity - Float
The new amount or number of this item.
selected_options - [ID]
An array of strings corresponding to options the customer selected.
wishlist_item_id - ID!
The unique ID for a `WishlistItemInterface` object.

Example

Copied to your clipboard
{
  "description": "abc123",
  "entered_options": [EnteredOptionInput],
  "quantity": 987.65,
  "selected_options": [4],
  "wishlist_item_id": 4
}

WishlistItems

Contains an array of items in a wish list.

Fields

Field NameDescription
items - [WishlistItemInterface]!
A list of items in the wish list.
page_info - SearchResultPageInfo
Contains pagination metadata.

Example

Copied to your clipboard
{
  "items": [WishlistItemInterface],
  "page_info": SearchResultPageInfo
}

WishlistOutput

Deprecated: Use the Wishlist type instead.

Fields

Field NameDescription
items - [WishlistItem]
An array of items in the customer's wish list (Deprecated: Use the `Wishlist.items` field instead.)
items_count - Int
The number of items in the wish list. (Deprecated: Use the `Wishlist.items_count` field instead.)
name - String
When multiple wish lists are enabled, the name the customer assigns to the wishlist. (Deprecated: This field is related to Commerce functionality and is always `null` in Open Source.)
sharing_code - String
An encrypted code that links to the wish list. (Deprecated: Use the `Wishlist.sharing_code` field instead.)
updated_at - String
The time of the last modification to the wish list. (Deprecated: Use the `Wishlist.updated_at` field instead.)

Example

Copied to your clipboard
{
  "items": [WishlistItem],
  "items_count": 987,
  "name": "abc123",
  "sharing_code": "xyz789",
  "updated_at": "xyz789"
}

WishlistVisibilityEnum

Defines the wish list visibility types.

Values

Enum ValueDescription
PUBLIC
PRIVATE

Example

Copied to your clipboard
""PUBLIC""

createEmptyCartInput

Assigns a specific cart_id to the empty cart.

Input Fields

Input FieldDescription
cart_id - String
The ID to assign to the cart.

Example

Copied to your clipboard
{"cart_id": "xyz789"}
Was this helpful?

Community

Support

Adobe Developer

  • Privacy
  • Terms of Use
  • Do not sell or share my personal information
  • AdChoices
Copyright © 2026 Adobe. All rights reserved.