From 1d4cf59ced821f10db5668ac933ab72e180b4e73 Mon Sep 17 00:00:00 2001 From: Dima Shevtsov Date: Thu, 30 Jan 2025 17:35:00 -0600 Subject: [PATCH 01/11] Enable OneFile for SpectaQL CS/JS --- spectaql/config.yml | 8 +- static/graphql-api/index.html | 146355 ++++++++++++++++--------------- 2 files changed, 73184 insertions(+), 73179 deletions(-) diff --git a/spectaql/config.yml b/spectaql/config.yml index 6e77969f0..58cc15268 100644 --- a/spectaql/config.yml +++ b/spectaql/config.yml @@ -6,11 +6,11 @@ spectaql: # Optional Boolean indicating whether to omit the HTML and generate the documentation content only # Default: false - embeddable: true + # embeddable: true # Optional Boolean indicating whether to embed all resources (CSS and JS) into the same file # Default: false - oneFile: false + oneFile: true # Optional path to the target build directory. # Set to null to not write the output to the filesystem, making it only available via the API (default: public) @@ -439,8 +439,8 @@ info: # A non-standard array of items to display in your Introduction Area x-introItems: # Can be a Title (for the Nav panel) + URL to simply add a link to somewhere - - title: WebAPI guide - url: https://developer.adobe.com/commerce/webapi/ + - title: Back to the GraphQL guide + url: https://developer.adobe.com/commerce/webapi/graphql/ # Can be a Title (for the Nav panel) + description (for the Content panel) # - title: Important thing 1 # description: Some important stuff we wanted you to know. Supports `markdown` diff --git a/static/graphql-api/index.html b/static/graphql-api/index.html index 66a90b09f..ab3a2acf1 100644 --- a/static/graphql-api/index.html +++ b/static/graphql-api/index.html @@ -1,1120 +1,1127 @@ - - -
-
-
-
- \ No newline at end of file + + \ No newline at end of file From fdff52024cea3d04dc1de90f2c40e85852807d3f Mon Sep 17 00:00:00 2001 From: Dima Shevtsov Date: Mon, 3 Feb 2025 14:52:31 -0600 Subject: [PATCH 02/11] Delete unused beta artifacts --- static/graphql-api/beta/index.html | 82275 ---------------- .../beta/javascripts/spectaql.min.js | 1 - .../beta/stylesheets/spectaql.min.css | 1 - 3 files changed, 82277 deletions(-) delete mode 100644 static/graphql-api/beta/index.html delete mode 100644 static/graphql-api/beta/javascripts/spectaql.min.js delete mode 100644 static/graphql-api/beta/stylesheets/spectaql.min.css diff --git a/static/graphql-api/beta/index.html b/static/graphql-api/beta/index.html deleted file mode 100644 index 4d9aa422f..000000000 --- a/static/graphql-api/beta/index.html +++ /dev/null @@ -1,82275 +0,0 @@ - - - - - - GraphQL API - - - - -
- -
-
- -
-
-

Adobe Commerce GraphQL API (Legacy)

-
-
-
-

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

-
-
-
-
API Endpoints
https://<your store>/graphql
-
-
Version
-

2.4.6

-
-
-
-
-

Queries

-
-

availableStores

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns - [StoreConfig] -

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

Example

-
-
Query
- - - 
query availableStores($useCurrentGroup: Boolean) {
-  availableStores(useCurrentGroup: $useCurrentGroup) {
-    absolute_footer
-    allow_gift_receipt
-    allow_gift_wrapping_on_order
-    allow_gift_wrapping_on_order_items
-    allow_guests_to_write_product_reviews
-    allow_items
-    allow_order
-    allow_printed_card
-    autocomplete_on_storefront
-    base_currency_code
-    base_link_url
-    base_media_url
-    base_static_url
-    base_url
-    braintree_cc_vault_active
-    cart_gift_wrapping
-    cart_printed_card
-    catalog_default_sort_by
-    category_fixed_product_tax_display_setting
-    category_url_suffix
-    check_money_order_enable_for_specific_countries
-    check_money_order_enabled
-    check_money_order_make_check_payable_to
-    check_money_order_max_order_total
-    check_money_order_min_order_total
-    check_money_order_new_order_status
-    check_money_order_payment_from_specific_countries
-    check_money_order_send_check_to
-    check_money_order_sort_order
-    check_money_order_title
-    cms_home_page
-    cms_no_cookies
-    cms_no_route
-    code
-    configurable_thumbnail_source
-    copyright
-    default_description
-    default_display_currency_code
-    default_keywords
-    default_title
-    demonotice
-    enable_multiple_wishlists
-    front
-    grid_per_page
-    grid_per_page_values
-    head_includes
-    head_shortcut_icon
-    header_logo_src
-    id
-    is_default_store
-    is_default_store_group
-    is_negotiable_quote_active
-    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
-    maximum_number_of_wishlists
-    minimum_password_length
-    no_route
-    payment_payflowpro_cc_vault_active
-    printed_card_price
-    product_fixed_product_tax_display_setting
-    product_reviews_enabled
-    product_url_suffix
-    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
-    }
-    show_cms_breadcrumbs
-    store_code
-    store_group_code
-    store_group_name
-    store_name
-    store_sort_order
-    timezone
-    title_prefix
-    title_separator
-    title_suffix
-    use_store_in_url
-    website_code
-    website_id
-    website_name
-    weight_unit
-    welcome
-    zero_subtotal_enable_for_specific_countries
-    zero_subtotal_enabled
-    zero_subtotal_new_order_status
-    zero_subtotal_payment_action
-    zero_subtotal_payment_from_specific_countries
-    zero_subtotal_sort_order
-    zero_subtotal_title
-  }
-}
-
- -
-
-
Variables
- - - 
{"useCurrentGroup": false}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "availableStores": [
-      {
-        "absolute_footer": "xyz789",
-        "allow_gift_receipt": "xyz789",
-        "allow_gift_wrapping_on_order": "xyz789",
-        "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": true,
-        "base_currency_code": "xyz789",
-        "base_link_url": "abc123",
-        "base_media_url": "xyz789",
-        "base_static_url": "abc123",
-        "base_url": "xyz789",
-        "braintree_cc_vault_active": "abc123",
-        "cart_gift_wrapping": "abc123",
-        "cart_printed_card": "xyz789",
-        "catalog_default_sort_by": "xyz789",
-        "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
-        "category_url_suffix": "xyz789",
-        "check_money_order_enable_for_specific_countries": true,
-        "check_money_order_enabled": false,
-        "check_money_order_make_check_payable_to": "xyz789",
-        "check_money_order_max_order_total": "abc123",
-        "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": "abc123",
-        "check_money_order_sort_order": 987,
-        "check_money_order_title": "abc123",
-        "cms_home_page": "xyz789",
-        "cms_no_cookies": "abc123",
-        "cms_no_route": "abc123",
-        "code": "xyz789",
-        "configurable_thumbnail_source": "abc123",
-        "copyright": "abc123",
-        "default_description": "abc123",
-        "default_display_currency_code": "xyz789",
-        "default_keywords": "xyz789",
-        "default_title": "xyz789",
-        "demonotice": 123,
-        "enable_multiple_wishlists": "xyz789",
-        "front": "abc123",
-        "grid_per_page": 123,
-        "grid_per_page_values": "abc123",
-        "head_includes": "abc123",
-        "head_shortcut_icon": "abc123",
-        "header_logo_src": "xyz789",
-        "id": 123,
-        "is_default_store": true,
-        "is_default_store_group": false,
-        "is_negotiable_quote_active": false,
-        "is_requisition_list_active": "abc123",
-        "list_mode": "xyz789",
-        "list_per_page": 123,
-        "list_per_page_values": "xyz789",
-        "locale": "abc123",
-        "logo_alt": "xyz789",
-        "logo_height": 123,
-        "logo_width": 123,
-        "magento_reward_general_is_enabled": "xyz789",
-        "magento_reward_general_is_enabled_on_front": "abc123",
-        "magento_reward_general_min_points_balance": "xyz789",
-        "magento_reward_general_publish_history": "abc123",
-        "magento_reward_points_invitation_customer": "abc123",
-        "magento_reward_points_invitation_customer_limit": "abc123",
-        "magento_reward_points_invitation_order": "abc123",
-        "magento_reward_points_invitation_order_limit": "xyz789",
-        "magento_reward_points_newsletter": "abc123",
-        "magento_reward_points_order": "xyz789",
-        "magento_reward_points_register": "xyz789",
-        "magento_reward_points_review": "xyz789",
-        "magento_reward_points_review_limit": "xyz789",
-        "magento_wishlist_general_is_enabled": "abc123",
-        "maximum_number_of_wishlists": "xyz789",
-        "minimum_password_length": "xyz789",
-        "no_route": "xyz789",
-        "payment_payflowpro_cc_vault_active": "xyz789",
-        "printed_card_price": "xyz789",
-        "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
-        "product_reviews_enabled": "xyz789",
-        "product_url_suffix": "xyz789",
-        "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": "abc123",
-        "sales_printed_card": "abc123",
-        "secure_base_link_url": "xyz789",
-        "secure_base_media_url": "xyz789",
-        "secure_base_static_url": "xyz789",
-        "secure_base_url": "abc123",
-        "send_friend": SendFriendConfiguration,
-        "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": "abc123",
-        "title_separator": "abc123",
-        "title_suffix": "abc123",
-        "use_store_in_url": false,
-        "website_code": "4",
-        "website_id": 987,
-        "website_name": "abc123",
-        "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": "xyz789",
-        "zero_subtotal_payment_from_specific_countries": "xyz789",
-        "zero_subtotal_sort_order": 987,
-        "zero_subtotal_title": "abc123"
-      }
-    ]
-  }
-}
-
- -
-
-
-
-
-
- Queries -
-

cart

-
-
-
-
Description
-

Return information about the specified shopping cart.

-
-
-
-
-
-
-
Response
-

Returns a - Cart -

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

Example

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

categories

-
-
-
-
Description
-

Return a list of categories that match the specified filter.

-
-
-
-
-
-
-
Response
-

Returns a - 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
- - - 
query categories(
-  $filters: CategoryFilterInput,
-  $pageSize: Int,
-  $currentPage: Int
-) {
-  categories(
-    filters: $filters,
-    pageSize: $pageSize,
-    currentPage: $currentPage
-  ) {
-    items {
-      ...CategoryTreeFragment
-    }
-    page_info {
-      ...SearchResultPageInfoFragment
-    }
-    total_count
-  }
-}
-
- -
-
-
Variables
- - - 
{
-  "filters": CategoryFilterInput,
-  "pageSize": 20,
-  "currentPage": 1
-}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "categories": {
-      "items": [CategoryTree],
-      "page_info": SearchResultPageInfo,
-      "total_count": 987
-    }
-  }
-}
-
- -
-
-
-
-
-
- Queries -
-

category

-
-
-
-
Use categories instead.
-
-
-
-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns a - CategoryTree -

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

Example

-
-
Query
- - - 
query category($id: Int) {
-  category(id: $id) {
-    automatic_sorting
-    available_sort_by
-    breadcrumbs {
-      ...BreadcrumbFragment
-    }
-    canonical_url
-    children {
-      ...CategoryTreeFragment
-    }
-    children_count
-    cms_block {
-      ...CmsBlockFragment
-    }
-    created_at
-    custom_layout_update_file
-    default_sort_by
-    description
-    display_mode
-    filter_price_range
-    id
-    image
-    include_in_menu
-    is_anchor
-    landing_page
-    level
-    meta_description
-    meta_keywords
-    meta_title
-    name
-    path
-    path_in_store
-    position
-    product_count
-    products {
-      ...CategoryProductsFragment
-    }
-    redirect_code
-    relative_url
-    staged
-    type
-    uid
-    updated_at
-    url_key
-    url_path
-    url_suffix
-  }
-}
-
- -
-
-
Variables
- - - 
{"id": 987}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "category": {
-      "automatic_sorting": "abc123",
-      "available_sort_by": ["xyz789"],
-      "breadcrumbs": [Breadcrumb],
-      "canonical_url": "abc123",
-      "children": [CategoryTree],
-      "children_count": "xyz789",
-      "cms_block": CmsBlock,
-      "created_at": "abc123",
-      "custom_layout_update_file": "abc123",
-      "default_sort_by": "xyz789",
-      "description": "xyz789",
-      "display_mode": "xyz789",
-      "filter_price_range": 987.65,
-      "id": 987,
-      "image": "abc123",
-      "include_in_menu": 987,
-      "is_anchor": 123,
-      "landing_page": 123,
-      "level": 987,
-      "meta_description": "xyz789",
-      "meta_keywords": "xyz789",
-      "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": "xyz789",
-      "url_key": "xyz789",
-      "url_path": "abc123",
-      "url_suffix": "abc123"
-    }
-  }
-}
-
- -
-
-
-
-
-
- Queries -
-

categoryList

-
-
-
-
Use categories instead.
-
-
-
-
-
-
-
Description
-

Return an array of categories based on the specified filters.

-
-
-
-
-
-
-
Response
-

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

checkoutAgreements

-
-
-
-
Description
-

Return Terms and Conditions configuration information.

-
-
-
-
-
-
-
Response
-

Returns - [CheckoutAgreement] -

-
-
-
-

Example

-
-
Query
- - - 
query checkoutAgreements {
-  checkoutAgreements {
-    agreement_id
-    checkbox_text
-    content
-    content_height
-    is_html
-    mode
-    name
-  }
-}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "checkoutAgreements": [
-      {
-        "agreement_id": 987,
-        "checkbox_text": "abc123",
-        "content": "abc123",
-        "content_height": "xyz789",
-        "is_html": true,
-        "mode": "AUTO",
-        "name": "abc123"
-      }
-    ]
-  }
-}
-
- -
-
-
-
-
-
- Queries -
-

cmsBlocks

-
-
-
-
Description
-

Return information about CMS blocks.

-
-
-
-
-
-
-
Response
-

Returns a - CmsBlocks -

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

Example

-
-
Query
- - - 
query cmsBlocks($identifiers: [String]) {
-  cmsBlocks(identifiers: $identifiers) {
-    items {
-      ...CmsBlockFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"identifiers": ["xyz789"]}
-
- -
-
-
Response
- - - 
{"data": {"cmsBlocks": {"items": [CmsBlock]}}}
-
- -
-
-
-
-
-
- Queries -
-

cmsPage

-
-
-
-
Description
-

Return details about a CMS page.

-
-
-
-
-
-
-
Response
-

Returns a - CmsPage -

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

Example

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

company

-
-
-
-
Description
-

Return detailed information about the authenticated customer's company.

-
-
-
-
-
-
-
Response
-

Returns a - Company -

-
-
-
-

Example

-
-
Query
- - - 
query company {
-  company {
-    acl_resources {
-      ...CompanyAclResourceFragment
-    }
-    company_admin {
-      ...CustomerFragment
-    }
-    credit {
-      ...CompanyCreditFragment
-    }
-    credit_history {
-      ...CompanyCreditHistoryFragment
-    }
-    email
-    id
-    legal_address {
-      ...CompanyLegalAddressFragment
-    }
-    legal_name
-    name
-    payment_methods
-    reseller_id
-    role {
-      ...CompanyRoleFragment
-    }
-    roles {
-      ...CompanyRolesFragment
-    }
-    sales_representative {
-      ...CompanySalesRepresentativeFragment
-    }
-    structure {
-      ...CompanyStructureFragment
-    }
-    team {
-      ...CompanyTeamFragment
-    }
-    user {
-      ...CustomerFragment
-    }
-    users {
-      ...CompanyUsersFragment
-    }
-    vat_tax_id
-  }
-}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "company": {
-      "acl_resources": [CompanyAclResource],
-      "company_admin": Customer,
-      "credit": CompanyCredit,
-      "credit_history": CompanyCreditHistory,
-      "email": "xyz789",
-      "id": "4",
-      "legal_address": CompanyLegalAddress,
-      "legal_name": "abc123",
-      "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": "abc123"
-    }
-  }
-}
-
- -
-
-
-
-
-
- Queries -
-

compareList

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns a - CompareList -

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

Example

-
-
Query
- - - 
query compareList($uid: ID!) {
-  compareList(uid: $uid) {
-    attributes {
-      ...ComparableAttributeFragment
-    }
-    item_count
-    items {
-      ...ComparableItemFragment
-    }
-    uid
-  }
-}
-
- -
-
-
Variables
- - - 
{"uid": 4}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "compareList": {
-      "attributes": [ComparableAttribute],
-      "item_count": 987,
-      "items": [ComparableItem],
-      "uid": "4"
-    }
-  }
-}
-
- -
-
-
-
-
-
- Queries -
-

countries

-
-
-
-
Description
-

The countries query provides information for all countries.

-
-
-
-
-
-
-
Response
-

Returns - [Country] -

-
-
-
-

Example

-
-
Query
- - - 
query countries {
-  countries {
-    available_regions {
-      ...RegionFragment
-    }
-    full_name_english
-    full_name_locale
-    id
-    three_letter_abbreviation
-    two_letter_abbreviation
-  }
-}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "countries": [
-      {
-        "available_regions": [Region],
-        "full_name_english": "abc123",
-        "full_name_locale": "xyz789",
-        "id": "xyz789",
-        "three_letter_abbreviation": "xyz789",
-        "two_letter_abbreviation": "xyz789"
-      }
-    ]
-  }
-}
-
- -
-
-
-
-
-
- Queries -
-

country

-
-
-
-
Description
-

The countries query provides information for a single country.

-
-
-
-
-
-
-
Response
-

Returns a - Country -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- id - - - String - -
-
-
-
-

Example

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

currency

-
-
-
-
Description
-

Return information about the store's currency.

-
-
-
-
-
-
-
Response
-

Returns a - Currency -

-
-
-
-

Example

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

customAttributeMetadata

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns a - CustomAttributeMetadata -

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

Example

-
-
Query
- - - 
query customAttributeMetadata($attributes: [AttributeInput!]!) {
-  customAttributeMetadata(attributes: $attributes) {
-    items {
-      ...AttributeFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"attributes": [AttributeInput]}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "customAttributeMetadata": {"items": [Attribute]}
-  }
-}
-
- -
-
-
-
-
-
- Queries -
-

customer

-
-
-
-
Description
-

Return detailed information about a customer account.

-
-
-
-
-
-
-
Response
-

Returns a - Customer -

-
-
-
-

Example

-
-
Query
- - - 
query customer {
-  customer {
-    addresses {
-      ...CustomerAddressFragment
-    }
-    allow_remote_shopping_assistance
-    compare_list {
-      ...CompareListFragment
-    }
-    created_at
-    date_of_birth
-    default_billing
-    default_shipping
-    dob
-    email
-    firstname
-    gender
-    gift_registries {
-      ...GiftRegistryFragment
-    }
-    gift_registry {
-      ...GiftRegistryFragment
-    }
-    group_id
-    id
-    is_subscribed
-    job_title
-    lastname
-    middlename
-    orders {
-      ...CustomerOrdersFragment
-    }
-    prefix
-    purchase_order {
-      ...PurchaseOrderFragment
-    }
-    purchase_order_approval_rule {
-      ...PurchaseOrderApprovalRuleFragment
-    }
-    purchase_order_approval_rule_metadata {
-      ...PurchaseOrderApprovalRuleMetadataFragment
-    }
-    purchase_order_approval_rules {
-      ...PurchaseOrderApprovalRulesFragment
-    }
-    purchase_orders {
-      ...PurchaseOrdersFragment
-    }
-    purchase_orders_enabled
-    requisition_lists {
-      ...RequisitionListsFragment
-    }
-    return {
-      ...ReturnFragment
-    }
-    returns {
-      ...ReturnsFragment
-    }
-    reviews {
-      ...ProductReviewsFragment
-    }
-    reward_points {
-      ...RewardPointsFragment
-    }
-    role {
-      ...CompanyRoleFragment
-    }
-    status
-    store_credit {
-      ...CustomerStoreCreditFragment
-    }
-    structure_id
-    suffix
-    taxvat
-    team {
-      ...CompanyTeamFragment
-    }
-    telephone
-    wishlist {
-      ...WishlistFragment
-    }
-    wishlist_v2 {
-      ...WishlistFragment
-    }
-    wishlists {
-      ...WishlistFragment
-    }
-  }
-}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "customer": {
-      "addresses": [CustomerAddress],
-      "allow_remote_shopping_assistance": true,
-      "compare_list": CompareList,
-      "created_at": "xyz789",
-      "date_of_birth": "abc123",
-      "default_billing": "xyz789",
-      "default_shipping": "abc123",
-      "dob": "xyz789",
-      "email": "abc123",
-      "firstname": "abc123",
-      "gender": 987,
-      "gift_registries": [GiftRegistry],
-      "gift_registry": GiftRegistry,
-      "group_id": 987,
-      "id": 987,
-      "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": false,
-      "requisition_lists": RequisitionLists,
-      "return": Return,
-      "returns": Returns,
-      "reviews": ProductReviews,
-      "reward_points": RewardPoints,
-      "role": CompanyRole,
-      "status": "ACTIVE",
-      "store_credit": CustomerStoreCredit,
-      "structure_id": "4",
-      "suffix": "abc123",
-      "taxvat": "xyz789",
-      "team": CompanyTeam,
-      "telephone": "abc123",
-      "wishlist": Wishlist,
-      "wishlist_v2": Wishlist,
-      "wishlists": [Wishlist]
-    }
-  }
-}
-
- -
-
-
-
-
-
- Queries -
-

customerCart

-
-
-
-
Description
-

Return information about the customer's shopping cart.

-
-
-
-
-
-
-
Response
-

Returns a - Cart! -

-
-
-
-

Example

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

customerDownloadableProducts

-
-
-
-
Description
-

Return a list of downloadable products the customer has purchased.

-
-
-
-
-
-
-
Response
-

Returns a - CustomerDownloadableProducts -

-
-
-
-

Example

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

customerOrders

-
-
-
-
Use the customer query instead.
-
-
-
-
-
-
-
Response
-

Returns a - CustomerOrders -

-
-
-
-

Example

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

customerPaymentTokens

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns a - CustomerPaymentTokens -

-
-
-
-

Example

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

dynamicBlocks

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns a - 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
- - - 
query dynamicBlocks(
-  $input: DynamicBlocksFilterInput,
-  $pageSize: Int,
-  $currentPage: Int
-) {
-  dynamicBlocks(
-    input: $input,
-    pageSize: $pageSize,
-    currentPage: $currentPage
-  ) {
-    items {
-      ...DynamicBlockFragment
-    }
-    page_info {
-      ...SearchResultPageInfoFragment
-    }
-    total_count
-  }
-}
-
- -
-
-
Variables
- - - 
{
-  "input": DynamicBlocksFilterInput,
-  "pageSize": 20,
-  "currentPage": 1
-}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "dynamicBlocks": {
-      "items": [DynamicBlock],
-      "page_info": SearchResultPageInfo,
-      "total_count": 123
-    }
-  }
-}
-
- -
-
-
-
-
-
- Queries -
-

getHostedProUrl

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns a - HostedProUrl -

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

Example

-
-
Query
- - - 
query getHostedProUrl($input: HostedProUrlInput!) {
-  getHostedProUrl(input: $input) {
-    secure_form_url
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": HostedProUrlInput}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "getHostedProUrl": {
-      "secure_form_url": "abc123"
-    }
-  }
-}
-
- -
-
-
-
-
-
- Queries -
-

getPayflowLinkToken

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns a - PayflowLinkToken -

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

Example

-
-
Query
- - - 
query getPayflowLinkToken($input: PayflowLinkTokenInput!) {
-  getPayflowLinkToken(input: $input) {
-    mode
-    paypal_url
-    secure_token
-    secure_token_id
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": PayflowLinkTokenInput}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "getPayflowLinkToken": {
-      "mode": "TEST",
-      "paypal_url": "abc123",
-      "secure_token": "abc123",
-      "secure_token_id": "abc123"
-    }
-  }
-}
-
- -
-
-
-
-
-
- Queries -
-

giftCardAccount

-
-
-
-
Description
-

Return details about a specific gift card.

-
-
-
-
-
-
-
Response
-

Returns a - GiftCardAccount -

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

Example

-
-
Query
- - - 
query giftCardAccount($input: GiftCardAccountInput!) {
-  giftCardAccount(input: $input) {
-    balance {
-      ...MoneyFragment
-    }
-    code
-    expiration_date
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": GiftCardAccountInput}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "giftCardAccount": {
-      "balance": Money,
-      "code": "abc123",
-      "expiration_date": "xyz789"
-    }
-  }
-}
-
- -
-
-
-
-
-
- Queries -
-

giftRegistry

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns a - GiftRegistry -

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

Example

-
-
Query
- - - 
query giftRegistry($giftRegistryUid: ID!) {
-  giftRegistry(giftRegistryUid: $giftRegistryUid) {
-    created_at
-    dynamic_attributes {
-      ...GiftRegistryDynamicAttributeFragment
-    }
-    event_name
-    items {
-      ...GiftRegistryItemInterfaceFragment
-    }
-    message
-    owner_name
-    privacy_settings
-    registrants {
-      ...GiftRegistryRegistrantFragment
-    }
-    shipping_address {
-      ...CustomerAddressFragment
-    }
-    status
-    type {
-      ...GiftRegistryTypeFragment
-    }
-    uid
-  }
-}
-
- -
-
-
Variables
- - - 
{"giftRegistryUid": "4"}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "giftRegistry": {
-      "created_at": "abc123",
-      "dynamic_attributes": [
-        GiftRegistryDynamicAttribute
-      ],
-      "event_name": "abc123",
-      "items": [GiftRegistryItemInterface],
-      "message": "abc123",
-      "owner_name": "abc123",
-      "privacy_settings": "PRIVATE",
-      "registrants": [GiftRegistryRegistrant],
-      "shipping_address": CustomerAddress,
-      "status": "ACTIVE",
-      "type": GiftRegistryType,
-      "uid": 4
-    }
-  }
-}
-
- -
-
-
-
-
-
- Queries -
-

giftRegistryEmailSearch

-
-
-
-
Description
-

Search for gift registries by specifying a registrant email address.

-
-
-
-
-
-
-
Response
-

Returns - [GiftRegistrySearchResult] -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- email - - - String! - - The registrant's email.
-
-
-
-

Example

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

giftRegistryIdSearch

-
-
-
-
Description
-

Search for gift registries by specifying a registry URL key.

-
-
-
-
-
-
-
Response
-

Returns - [GiftRegistrySearchResult] -

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

Example

-
-
Query
- - - 
query giftRegistryIdSearch($giftRegistryUid: ID!) {
-  giftRegistryIdSearch(giftRegistryUid: $giftRegistryUid) {
-    event_date
-    event_title
-    gift_registry_uid
-    location
-    name
-    type
-  }
-}
-
- -
-
-
Variables
- - - 
{"giftRegistryUid": "4"}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "giftRegistryIdSearch": [
-      {
-        "event_date": "abc123",
-        "event_title": "abc123",
-        "gift_registry_uid": "4",
-        "location": "xyz789",
-        "name": "xyz789",
-        "type": "xyz789"
-      }
-    ]
-  }
-}
-
- -
-
-
-
-
-
- Queries -
-

giftRegistryTypeSearch

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns - [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
- - - 
query giftRegistryTypeSearch(
-  $firstName: String!,
-  $lastName: String!,
-  $giftRegistryTypeUid: ID
-) {
-  giftRegistryTypeSearch(
-    firstName: $firstName,
-    lastName: $lastName,
-    giftRegistryTypeUid: $giftRegistryTypeUid
-  ) {
-    event_date
-    event_title
-    gift_registry_uid
-    location
-    name
-    type
-  }
-}
-
- -
-
-
Variables
- - - 
{
-  "firstName": "xyz789",
-  "lastName": "xyz789",
-  "giftRegistryTypeUid": "4"
-}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "giftRegistryTypeSearch": [
-      {
-        "event_date": "xyz789",
-        "event_title": "abc123",
-        "gift_registry_uid": 4,
-        "location": "xyz789",
-        "name": "abc123",
-        "type": "abc123"
-      }
-    ]
-  }
-}
-
- -
-
-
-
-
-
- Queries -
-

giftRegistryTypes

-
-
-
-
Description
-

Get a list of available gift registry types.

-
-
-
-
-
-
-
Response
-

Returns - [GiftRegistryType] -

-
-
-
-

Example

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

isCompanyAdminEmailAvailable

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns an - IsCompanyAdminEmailAvailableOutput -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- email - - - String! - -
-
-
-
-

Example

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

isCompanyEmailAvailable

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns an - IsCompanyEmailAvailableOutput -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- email - - - String! - -
-
-
-
-

Example

-
-
Query
- - - 
query isCompanyEmailAvailable($email: String!) {
-  isCompanyEmailAvailable(email: $email) {
-    is_email_available
-  }
-}
-
- -
-
-
Variables
- - - 
{"email": "abc123"}
-
- -
-
-
Response
- - - 
{"data": {"isCompanyEmailAvailable": {"is_email_available": true}}}
-
- -
-
-
-
-
-
- Queries -
-

isCompanyRoleNameAvailable

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns an - IsCompanyRoleNameAvailableOutput -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- name - - - String! - -
-
-
-
-

Example

-
-
Query
- - - 
query isCompanyRoleNameAvailable($name: String!) {
-  isCompanyRoleNameAvailable(name: $name) {
-    is_role_name_available
-  }
-}
-
- -
-
-
Variables
- - - 
{"name": "xyz789"}
-
- -
-
-
Response
- - - 
{"data": {"isCompanyRoleNameAvailable": {"is_role_name_available": true}}}
-
- -
-
-
-
-
-
- Queries -
-

isCompanyUserEmailAvailable

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns an - IsCompanyUserEmailAvailableOutput -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- email - - - String! - -
-
-
-
-

Example

-
-
Query
- - - 
query isCompanyUserEmailAvailable($email: String!) {
-  isCompanyUserEmailAvailable(email: $email) {
-    is_email_available
-  }
-}
-
- -
-
-
Variables
- - - 
{"email": "abc123"}
-
- -
-
-
Response
- - - 
{"data": {"isCompanyUserEmailAvailable": {"is_email_available": true}}}
-
- -
-
-
-
-
-
- Queries -
-

isEmailAvailable

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns an - IsEmailAvailableOutput -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- email - - - String! - - The email address to check.
-
-
-
-

Example

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

negotiableQuote

-
-
-
-
Description
-

Retrieve the specified negotiable quote.

-
-
-
-
-
-
-
Response
-

Returns a - NegotiableQuote -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- uid - - - ID! - -
-
-
-
-

Example

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

negotiableQuotes

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns a - 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
- - - 
query negotiableQuotes(
-  $filter: NegotiableQuoteFilterInput,
-  $pageSize: Int,
-  $currentPage: Int,
-  $sort: NegotiableQuoteSortInput
-) {
-  negotiableQuotes(
-    filter: $filter,
-    pageSize: $pageSize,
-    currentPage: $currentPage,
-    sort: $sort
-  ) {
-    items {
-      ...NegotiableQuoteFragment
-    }
-    page_info {
-      ...SearchResultPageInfoFragment
-    }
-    sort_fields {
-      ...SortFieldsFragment
-    }
-    total_count
-  }
-}
-
- -
-
-
Variables
- - - 
{
-  "filter": NegotiableQuoteFilterInput,
-  "pageSize": 20,
-  "currentPage": 1,
-  "sort": NegotiableQuoteSortInput
-}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "negotiableQuotes": {
-      "items": [NegotiableQuote],
-      "page_info": SearchResultPageInfo,
-      "sort_fields": SortFields,
-      "total_count": 123
-    }
-  }
-}
-
- -
-
-
-
-
-
- Queries -
-

pickupLocations

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns a - 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
- - - 
query pickupLocations(
-  $area: AreaInput,
-  $filters: PickupLocationFilterInput,
-  $sort: PickupLocationSortInput,
-  $pageSize: Int,
-  $currentPage: Int,
-  $productsInfo: [ProductInfoInput]
-) {
-  pickupLocations(
-    area: $area,
-    filters: $filters,
-    sort: $sort,
-    pageSize: $pageSize,
-    currentPage: $currentPage,
-    productsInfo: $productsInfo
-  ) {
-    items {
-      ...PickupLocationFragment
-    }
-    page_info {
-      ...SearchResultPageInfoFragment
-    }
-    total_count
-  }
-}
-
- -
-
-
Variables
- - - 
{
-  "area": AreaInput,
-  "filters": PickupLocationFilterInput,
-  "sort": PickupLocationSortInput,
-  "pageSize": 20,
-  "currentPage": 1,
-  "productsInfo": [ProductInfoInput]
-}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "pickupLocations": {
-      "items": [PickupLocation],
-      "page_info": SearchResultPageInfo,
-      "total_count": 123
-    }
-  }
-}
-
- -
-
-
-
-
-
- Queries -
-

productReviewRatingsMetadata

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns a - ProductReviewRatingsMetadata! -

-
-
-
-

Example

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

products

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns a - 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
- - - 
query products(
-  $search: String,
-  $filter: ProductAttributeFilterInput,
-  $pageSize: Int,
-  $currentPage: Int,
-  $sort: ProductAttributeSortInput
-) {
-  products(
-    search: $search,
-    filter: $filter,
-    pageSize: $pageSize,
-    currentPage: $currentPage,
-    sort: $sort
-  ) {
-    aggregations {
-      ...AggregationFragment
-    }
-    filters {
-      ...LayerFilterFragment
-    }
-    items {
-      ...ProductInterfaceFragment
-    }
-    page_info {
-      ...SearchResultPageInfoFragment
-    }
-    sort_fields {
-      ...SortFieldsFragment
-    }
-    suggestions {
-      ...SearchSuggestionFragment
-    }
-    total_count
-  }
-}
-
- -
-
-
Variables
- - - 
{
-  "search": "xyz789",
-  "filter": ProductAttributeFilterInput,
-  "pageSize": 20,
-  "currentPage": 1,
-  "sort": ProductAttributeSortInput
-}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "products": {
-      "aggregations": [Aggregation],
-      "filters": [LayerFilter],
-      "items": [ProductInterface],
-      "page_info": SearchResultPageInfo,
-      "sort_fields": SortFields,
-      "suggestions": [SearchSuggestion],
-      "total_count": 987
-    }
-  }
-}
-
- -
-
-
-
-
-
- Queries -
-

route

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns a - RoutableInterface -

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

Example

-
-
Query
- - - 
query route($url: String!) {
-  route(url: $url) {
-    redirect_code
-    relative_url
-    type
-  }
-}
-
- -
-
-
Variables
- - - 
{"url": "xyz789"}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "route": {
-      "redirect_code": 987,
-      "relative_url": "abc123",
-      "type": "CMS_PAGE"
-    }
-  }
-}
-
- -
-
-
-
-
-
- Queries -
-

storeConfig

-
-
-
-
Description
-

Return details about the store's configuration.

-
-
-
-
-
-
-
Response
-

Returns a - StoreConfig -

-
-
-
-

Example

-
-
Query
- - - 
query storeConfig {
-  storeConfig {
-    absolute_footer
-    allow_gift_receipt
-    allow_gift_wrapping_on_order
-    allow_gift_wrapping_on_order_items
-    allow_guests_to_write_product_reviews
-    allow_items
-    allow_order
-    allow_printed_card
-    autocomplete_on_storefront
-    base_currency_code
-    base_link_url
-    base_media_url
-    base_static_url
-    base_url
-    braintree_cc_vault_active
-    cart_gift_wrapping
-    cart_printed_card
-    catalog_default_sort_by
-    category_fixed_product_tax_display_setting
-    category_url_suffix
-    check_money_order_enable_for_specific_countries
-    check_money_order_enabled
-    check_money_order_make_check_payable_to
-    check_money_order_max_order_total
-    check_money_order_min_order_total
-    check_money_order_new_order_status
-    check_money_order_payment_from_specific_countries
-    check_money_order_send_check_to
-    check_money_order_sort_order
-    check_money_order_title
-    cms_home_page
-    cms_no_cookies
-    cms_no_route
-    code
-    configurable_thumbnail_source
-    copyright
-    default_description
-    default_display_currency_code
-    default_keywords
-    default_title
-    demonotice
-    enable_multiple_wishlists
-    front
-    grid_per_page
-    grid_per_page_values
-    head_includes
-    head_shortcut_icon
-    header_logo_src
-    id
-    is_default_store
-    is_default_store_group
-    is_negotiable_quote_active
-    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
-    maximum_number_of_wishlists
-    minimum_password_length
-    no_route
-    payment_payflowpro_cc_vault_active
-    printed_card_price
-    product_fixed_product_tax_display_setting
-    product_reviews_enabled
-    product_url_suffix
-    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
-    }
-    show_cms_breadcrumbs
-    store_code
-    store_group_code
-    store_group_name
-    store_name
-    store_sort_order
-    timezone
-    title_prefix
-    title_separator
-    title_suffix
-    use_store_in_url
-    website_code
-    website_id
-    website_name
-    weight_unit
-    welcome
-    zero_subtotal_enable_for_specific_countries
-    zero_subtotal_enabled
-    zero_subtotal_new_order_status
-    zero_subtotal_payment_action
-    zero_subtotal_payment_from_specific_countries
-    zero_subtotal_sort_order
-    zero_subtotal_title
-  }
-}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "storeConfig": {
-      "absolute_footer": "abc123",
-      "allow_gift_receipt": "abc123",
-      "allow_gift_wrapping_on_order": "xyz789",
-      "allow_gift_wrapping_on_order_items": "xyz789",
-      "allow_guests_to_write_product_reviews": "abc123",
-      "allow_items": "xyz789",
-      "allow_order": "xyz789",
-      "allow_printed_card": "xyz789",
-      "autocomplete_on_storefront": true,
-      "base_currency_code": "abc123",
-      "base_link_url": "xyz789",
-      "base_media_url": "xyz789",
-      "base_static_url": "abc123",
-      "base_url": "xyz789",
-      "braintree_cc_vault_active": "abc123",
-      "cart_gift_wrapping": "abc123",
-      "cart_printed_card": "xyz789",
-      "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": false,
-      "check_money_order_enabled": true,
-      "check_money_order_make_check_payable_to": "xyz789",
-      "check_money_order_max_order_total": "abc123",
-      "check_money_order_min_order_total": "abc123",
-      "check_money_order_new_order_status": "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": "xyz789",
-      "cms_no_cookies": "abc123",
-      "cms_no_route": "xyz789",
-      "code": "xyz789",
-      "configurable_thumbnail_source": "xyz789",
-      "copyright": "xyz789",
-      "default_description": "xyz789",
-      "default_display_currency_code": "abc123",
-      "default_keywords": "abc123",
-      "default_title": "abc123",
-      "demonotice": 987,
-      "enable_multiple_wishlists": "xyz789",
-      "front": "abc123",
-      "grid_per_page": 123,
-      "grid_per_page_values": "abc123",
-      "head_includes": "abc123",
-      "head_shortcut_icon": "xyz789",
-      "header_logo_src": "abc123",
-      "id": 987,
-      "is_default_store": false,
-      "is_default_store_group": true,
-      "is_negotiable_quote_active": true,
-      "is_requisition_list_active": "xyz789",
-      "list_mode": "xyz789",
-      "list_per_page": 987,
-      "list_per_page_values": "abc123",
-      "locale": "abc123",
-      "logo_alt": "abc123",
-      "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": "abc123",
-      "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": "xyz789",
-      "magento_reward_points_order": "xyz789",
-      "magento_reward_points_register": "xyz789",
-      "magento_reward_points_review": "xyz789",
-      "magento_reward_points_review_limit": "xyz789",
-      "magento_wishlist_general_is_enabled": "abc123",
-      "maximum_number_of_wishlists": "xyz789",
-      "minimum_password_length": "xyz789",
-      "no_route": "xyz789",
-      "payment_payflowpro_cc_vault_active": "abc123",
-      "printed_card_price": "abc123",
-      "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
-      "product_reviews_enabled": "abc123",
-      "product_url_suffix": "xyz789",
-      "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": "abc123",
-      "secure_base_media_url": "abc123",
-      "secure_base_static_url": "abc123",
-      "secure_base_url": "abc123",
-      "send_friend": SendFriendConfiguration,
-      "show_cms_breadcrumbs": 987,
-      "store_code": "4",
-      "store_group_code": 4,
-      "store_group_name": "abc123",
-      "store_name": "xyz789",
-      "store_sort_order": 123,
-      "timezone": "abc123",
-      "title_prefix": "xyz789",
-      "title_separator": "xyz789",
-      "title_suffix": "xyz789",
-      "use_store_in_url": true,
-      "website_code": 4,
-      "website_id": 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": "abc123",
-      "zero_subtotal_payment_action": "xyz789",
-      "zero_subtotal_payment_from_specific_countries": "xyz789",
-      "zero_subtotal_sort_order": 123,
-      "zero_subtotal_title": "abc123"
-    }
-  }
-}
-
- -
-
-
-
-
-
- Queries -
-

urlResolver

-
-
-
-
Use the route query instead.
-
-
-
-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns an - EntityUrl -

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

Example

-
-
Query
- - - 
query urlResolver($url: String!) {
-  urlResolver(url: $url) {
-    canonical_url
-    entity_uid
-    id
-    redirectCode
-    relative_url
-    type
-  }
-}
-
- -
-
-
Variables
- - - 
{"url": "xyz789"}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "urlResolver": {
-      "canonical_url": "xyz789",
-      "entity_uid": 4,
-      "id": 123,
-      "redirectCode": 123,
-      "relative_url": "xyz789",
-      "type": "CMS_PAGE"
-    }
-  }
-}
-
- -
-
-
-
-
-
- Queries -
-

wishlist

-
-
-
-
Moved under Customer.wishlist.
-
-
-
-
-
-
-
Description
-

Return the contents of a customer's wish list.

-
-
-
-
-
-
-
Response
-

Returns a - WishlistOutput -

-
-
-
-

Example

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

Mutations

-
-

addBundleProductsToCart

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns an - AddBundleProductsToCartOutput -

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

Example

-
-
Query
- - - 
mutation addBundleProductsToCart($input: AddBundleProductsToCartInput) {
-  addBundleProductsToCart(input: $input) {
-    cart {
-      ...CartFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": AddBundleProductsToCartInput}
-
- -
-
-
Response
- - - 
{"data": {"addBundleProductsToCart": {"cart": Cart}}}
-
- -
-
-
-
-
-
- Mutations -
-

addConfigurableProductsToCart

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns an - AddConfigurableProductsToCartOutput -

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

Example

-
-
Query
- - - 
mutation addConfigurableProductsToCart($input: AddConfigurableProductsToCartInput) {
-  addConfigurableProductsToCart(input: $input) {
-    cart {
-      ...CartFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": AddConfigurableProductsToCartInput}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "addConfigurableProductsToCart": {"cart": Cart}
-  }
-}
-
- -
-
-
-
-
-
- Mutations -
-

addDownloadableProductsToCart

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns an - AddDownloadableProductsToCartOutput -

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

Example

-
-
Query
- - - 
mutation addDownloadableProductsToCart($input: AddDownloadableProductsToCartInput) {
-  addDownloadableProductsToCart(input: $input) {
-    cart {
-      ...CartFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": AddDownloadableProductsToCartInput}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "addDownloadableProductsToCart": {"cart": Cart}
-  }
-}
-
- -
-
-
-
-
-
- Mutations -
-

addGiftRegistryRegistrants

-
-
-
-
Description
-

Add registrants to the specified gift registry.

-
-
-
-
-
-
-
Response
-

Returns an - AddGiftRegistryRegistrantsOutput -

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

Example

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

addProductsToCart

-
-
-
-
Description
-

Add any type of product to the cart.

-
-
-
-
-
-
-
Response
-

Returns an - 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
- - - 
mutation addProductsToCart(
-  $cartId: String!,
-  $cartItems: [CartItemInput!]!
-) {
-  addProductsToCart(
-    cartId: $cartId,
-    cartItems: $cartItems
-  ) {
-    cart {
-      ...CartFragment
-    }
-    user_errors {
-      ...CartUserInputErrorFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{
-  "cartId": "abc123",
-  "cartItems": [CartItemInput]
-}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "addProductsToCart": {
-      "cart": Cart,
-      "user_errors": [CartUserInputError]
-    }
-  }
-}
-
- -
-
-
-
-
-
- Mutations -
-

addProductsToCompareList

-
-
-
-
Description
-

Add products to the specified compare list.

-
-
-
-
-
-
-
Response
-

Returns a - CompareList -

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

Example

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

addProductsToRequisitionList

-
-
-
-
Description
-

Add items to the specified requisition list.

-
-
-
-
-
-
-
Response
-

Returns an - 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
- - - 
mutation addProductsToRequisitionList(
-  $requisitionListUid: ID!,
-  $requisitionListItems: [RequisitionListItemsInput!]!
-) {
-  addProductsToRequisitionList(
-    requisitionListUid: $requisitionListUid,
-    requisitionListItems: $requisitionListItems
-  ) {
-    requisition_list {
-      ...RequisitionListFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{
-  "requisitionListUid": 4,
-  "requisitionListItems": [RequisitionListItemsInput]
-}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "addProductsToRequisitionList": {
-      "requisition_list": RequisitionList
-    }
-  }
-}
-
- -
-
-
-
-
-
- Mutations -
-

addProductsToWishlist

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns an - 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
- - - 
mutation addProductsToWishlist(
-  $wishlistId: ID!,
-  $wishlistItems: [WishlistItemInput!]!
-) {
-  addProductsToWishlist(
-    wishlistId: $wishlistId,
-    wishlistItems: $wishlistItems
-  ) {
-    user_errors {
-      ...WishListUserInputErrorFragment
-    }
-    wishlist {
-      ...WishlistFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{
-  "wishlistId": "4",
-  "wishlistItems": [WishlistItemInput]
-}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "addProductsToWishlist": {
-      "user_errors": [WishListUserInputError],
-      "wishlist": Wishlist
-    }
-  }
-}
-
- -
-
-
-
-
-
- Mutations -
-

addPurchaseOrderComment

-
-
-
-
Description
-

Add a comment to an existing purchase order.

-
-
-
-
-
-
-
Response
-

Returns an - AddPurchaseOrderCommentOutput -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- input - - - AddPurchaseOrderCommentInput! - -
-
-
-
-

Example

-
-
Query
- - - 
mutation addPurchaseOrderComment($input: AddPurchaseOrderCommentInput!) {
-  addPurchaseOrderComment(input: $input) {
-    comment {
-      ...PurchaseOrderCommentFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": AddPurchaseOrderCommentInput}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "addPurchaseOrderComment": {
-      "comment": PurchaseOrderComment
-    }
-  }
-}
-
- -
-
-
-
-
-
- Mutations -
-

addPurchaseOrderItemsToCart

-
-
-
-
Description
-

Add purchase order items to the shopping cart.

-
-
-
-
-
-
-
Response
-

Returns an - AddProductsToCartOutput -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- input - - - AddPurchaseOrderItemsToCartInput! - -
-
-
-
-

Example

-
-
Query
- - - 
mutation addPurchaseOrderItemsToCart($input: AddPurchaseOrderItemsToCartInput!) {
-  addPurchaseOrderItemsToCart(input: $input) {
-    cart {
-      ...CartFragment
-    }
-    user_errors {
-      ...CartUserInputErrorFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": AddPurchaseOrderItemsToCartInput}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "addPurchaseOrderItemsToCart": {
-      "cart": Cart,
-      "user_errors": [CartUserInputError]
-    }
-  }
-}
-
- -
-
-
-
-
-
- Mutations -
-

addRequisitionListItemsToCart

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns an - 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
- - - 
mutation addRequisitionListItemsToCart(
-  $requisitionListUid: ID!,
-  $requisitionListItemUids: [ID!]
-) {
-  addRequisitionListItemsToCart(
-    requisitionListUid: $requisitionListUid,
-    requisitionListItemUids: $requisitionListItemUids
-  ) {
-    add_requisition_list_items_to_cart_user_errors {
-      ...AddRequisitionListItemToCartUserErrorFragment
-    }
-    cart {
-      ...CartFragment
-    }
-    status
-  }
-}
-
- -
-
-
Variables
- - - 
{"requisitionListUid": 4, "requisitionListItemUids": [4]}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "addRequisitionListItemsToCart": {
-      "add_requisition_list_items_to_cart_user_errors": [
-        AddRequisitionListItemToCartUserError
-      ],
-      "cart": Cart,
-      "status": true
-    }
-  }
-}
-
- -
-
-
-
-
-
- Mutations -
-

addReturnComment

-
-
-
-
Description
-

Add a comment to an existing return.

-
-
-
-
-
-
-
Response
-

Returns an - AddReturnCommentOutput -

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

Example

-
-
Query
- - - 
mutation addReturnComment($input: AddReturnCommentInput!) {
-  addReturnComment(input: $input) {
-    return {
-      ...ReturnFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": AddReturnCommentInput}
-
- -
-
-
Response
- - - 
{"data": {"addReturnComment": {"return": Return}}}
-
- -
-
-
-
-
-
- Mutations -
-

addReturnTracking

-
-
-
-
Description
-

Add tracking information to the return.

-
-
-
-
-
-
-
Response
-

Returns an - AddReturnTrackingOutput -

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

Example

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

addSimpleProductsToCart

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns an - AddSimpleProductsToCartOutput -

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

Example

-
-
Query
- - - 
mutation addSimpleProductsToCart($input: AddSimpleProductsToCartInput) {
-  addSimpleProductsToCart(input: $input) {
-    cart {
-      ...CartFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": AddSimpleProductsToCartInput}
-
- -
-
-
Response
- - - 
{"data": {"addSimpleProductsToCart": {"cart": Cart}}}
-
- -
-
-
-
-
-
- Mutations -
-

addVirtualProductsToCart

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns an - AddVirtualProductsToCartOutput -

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

Example

-
-
Query
- - - 
mutation addVirtualProductsToCart($input: AddVirtualProductsToCartInput) {
-  addVirtualProductsToCart(input: $input) {
-    cart {
-      ...CartFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": AddVirtualProductsToCartInput}
-
- -
-
-
Response
- - - 
{"data": {"addVirtualProductsToCart": {"cart": Cart}}}
-
- -
-
-
-
-
-
- Mutations -
-

addWishlistItemsToCart

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns an - 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
- - - 
mutation addWishlistItemsToCart(
-  $wishlistId: ID!,
-  $wishlistItemIds: [ID!]
-) {
-  addWishlistItemsToCart(
-    wishlistId: $wishlistId,
-    wishlistItemIds: $wishlistItemIds
-  ) {
-    add_wishlist_items_to_cart_user_errors {
-      ...WishlistCartUserInputErrorFragment
-    }
-    status
-    wishlist {
-      ...WishlistFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"wishlistId": "4", "wishlistItemIds": [4]}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "addWishlistItemsToCart": {
-      "add_wishlist_items_to_cart_user_errors": [
-        WishlistCartUserInputError
-      ],
-      "status": false,
-      "wishlist": Wishlist
-    }
-  }
-}
-
- -
-
-
-
-
-
- Mutations -
-

applyCouponToCart

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns an - ApplyCouponToCartOutput -

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

Example

-
-
Query
- - - 
mutation applyCouponToCart($input: ApplyCouponToCartInput) {
-  applyCouponToCart(input: $input) {
-    cart {
-      ...CartFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": ApplyCouponToCartInput}
-
- -
-
-
Response
- - - 
{"data": {"applyCouponToCart": {"cart": Cart}}}
-
- -
-
-
-
-
-
- Mutations -
-

applyGiftCardToCart

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns an - ApplyGiftCardToCartOutput -

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

Example

-
-
Query
- - - 
mutation applyGiftCardToCart($input: ApplyGiftCardToCartInput) {
-  applyGiftCardToCart(input: $input) {
-    cart {
-      ...CartFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": ApplyGiftCardToCartInput}
-
- -
-
-
Response
- - - 
{"data": {"applyGiftCardToCart": {"cart": Cart}}}
-
- -
-
-
-
-
-
- Mutations -
-

applyRewardPointsToCart

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns an - ApplyRewardPointsToCartOutput -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- cartId - - - ID! - -
-
-
-
-

Example

-
-
Query
- - - 
mutation applyRewardPointsToCart($cartId: ID!) {
-  applyRewardPointsToCart(cartId: $cartId) {
-    cart {
-      ...CartFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"cartId": "4"}
-
- -
-
-
Response
- - - 
{"data": {"applyRewardPointsToCart": {"cart": Cart}}}
-
- -
-
-
-
-
-
- Mutations -
-

applyStoreCreditToCart

-
-
-
-
Description
-

Apply store credit to the specified cart.

-
-
-
-
-
-
-
Response
-

Returns an - ApplyStoreCreditToCartOutput -

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

Example

-
-
Query
- - - 
mutation applyStoreCreditToCart($input: ApplyStoreCreditToCartInput!) {
-  applyStoreCreditToCart(input: $input) {
-    cart {
-      ...CartFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": ApplyStoreCreditToCartInput}
-
- -
-
-
Response
- - - 
{"data": {"applyStoreCreditToCart": {"cart": Cart}}}
-
- -
-
-
-
-
-
- Mutations -
-

approvePurchaseOrders

-
-
-
-
Description
-

Approve purchase orders.

-
-
-
-
-
-
-
Response
-

Returns a - PurchaseOrdersActionOutput -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- input - - - PurchaseOrdersActionInput! - -
-
-
-
-

Example

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

assignCompareListToCustomer

-
-
-
-
Description
-

Assign the specified compare list to the logged in customer.

-
-
-
-
-
-
-
Response
-

Returns an - AssignCompareListToCustomerOutput -

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

Example

-
-
Query
- - - 
mutation assignCompareListToCustomer($uid: ID!) {
-  assignCompareListToCustomer(uid: $uid) {
-    compare_list {
-      ...CompareListFragment
-    }
-    result
-  }
-}
-
- -
-
-
Variables
- - - 
{"uid": "4"}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "assignCompareListToCustomer": {
-      "compare_list": CompareList,
-      "result": false
-    }
-  }
-}
-
- -
-
-
-
-
-
- Mutations -
-

assignCustomerToGuestCart

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns a - Cart! -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- cart_id - - - String! - -
-
-
-
-

Example

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

cancelPurchaseOrders

-
-
-
-
Description
-

Cancel purchase orders.

-
-
-
-
-
-
-
Response
-

Returns a - PurchaseOrdersActionOutput -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- input - - - PurchaseOrdersActionInput! - -
-
-
-
-

Example

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

changeCustomerPassword

-
-
-
-
Description
-

Change the password for the logged-in customer.

-
-
-
-
-
-
-
Response
-

Returns a - Customer -

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

Example

-
-
Query
- - - 
mutation changeCustomerPassword(
-  $currentPassword: String!,
-  $newPassword: String!
-) {
-  changeCustomerPassword(
-    currentPassword: $currentPassword,
-    newPassword: $newPassword
-  ) {
-    addresses {
-      ...CustomerAddressFragment
-    }
-    allow_remote_shopping_assistance
-    compare_list {
-      ...CompareListFragment
-    }
-    created_at
-    date_of_birth
-    default_billing
-    default_shipping
-    dob
-    email
-    firstname
-    gender
-    gift_registries {
-      ...GiftRegistryFragment
-    }
-    gift_registry {
-      ...GiftRegistryFragment
-    }
-    group_id
-    id
-    is_subscribed
-    job_title
-    lastname
-    middlename
-    orders {
-      ...CustomerOrdersFragment
-    }
-    prefix
-    purchase_order {
-      ...PurchaseOrderFragment
-    }
-    purchase_order_approval_rule {
-      ...PurchaseOrderApprovalRuleFragment
-    }
-    purchase_order_approval_rule_metadata {
-      ...PurchaseOrderApprovalRuleMetadataFragment
-    }
-    purchase_order_approval_rules {
-      ...PurchaseOrderApprovalRulesFragment
-    }
-    purchase_orders {
-      ...PurchaseOrdersFragment
-    }
-    purchase_orders_enabled
-    requisition_lists {
-      ...RequisitionListsFragment
-    }
-    return {
-      ...ReturnFragment
-    }
-    returns {
-      ...ReturnsFragment
-    }
-    reviews {
-      ...ProductReviewsFragment
-    }
-    reward_points {
-      ...RewardPointsFragment
-    }
-    role {
-      ...CompanyRoleFragment
-    }
-    status
-    store_credit {
-      ...CustomerStoreCreditFragment
-    }
-    structure_id
-    suffix
-    taxvat
-    team {
-      ...CompanyTeamFragment
-    }
-    telephone
-    wishlist {
-      ...WishlistFragment
-    }
-    wishlist_v2 {
-      ...WishlistFragment
-    }
-    wishlists {
-      ...WishlistFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{
-  "currentPassword": "abc123",
-  "newPassword": "xyz789"
-}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "changeCustomerPassword": {
-      "addresses": [CustomerAddress],
-      "allow_remote_shopping_assistance": false,
-      "compare_list": CompareList,
-      "created_at": "abc123",
-      "date_of_birth": "xyz789",
-      "default_billing": "abc123",
-      "default_shipping": "xyz789",
-      "dob": "abc123",
-      "email": "abc123",
-      "firstname": "abc123",
-      "gender": 987,
-      "gift_registries": [GiftRegistry],
-      "gift_registry": GiftRegistry,
-      "group_id": 123,
-      "id": 123,
-      "is_subscribed": true,
-      "job_title": "abc123",
-      "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": false,
-      "requisition_lists": RequisitionLists,
-      "return": Return,
-      "returns": Returns,
-      "reviews": ProductReviews,
-      "reward_points": RewardPoints,
-      "role": CompanyRole,
-      "status": "ACTIVE",
-      "store_credit": CustomerStoreCredit,
-      "structure_id": "4",
-      "suffix": "abc123",
-      "taxvat": "abc123",
-      "team": CompanyTeam,
-      "telephone": "xyz789",
-      "wishlist": Wishlist,
-      "wishlist_v2": Wishlist,
-      "wishlists": [Wishlist]
-    }
-  }
-}
-
- -
-
-
-
-
-
- Mutations -
-

clearCustomerCart

-
-
-
-
Description
-

Remove all items from the specified cart.

-
-
-
-
-
-
-
Response
-

Returns a - ClearCustomerCartOutput -

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

Example

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

closeNegotiableQuotes

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns a - CloseNegotiableQuotesOutput -

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

Example

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

copyItemsBetweenRequisitionLists

-
-
-
-
Description
-

Copy items from one requisition list to another.

-
-
-
-
-
-
-
Response
-

Returns a - 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
- - - 
mutation copyItemsBetweenRequisitionLists(
-  $sourceRequisitionListUid: ID!,
-  $destinationRequisitionListUid: ID,
-  $requisitionListItem: CopyItemsBetweenRequisitionListsInput
-) {
-  copyItemsBetweenRequisitionLists(
-    sourceRequisitionListUid: $sourceRequisitionListUid,
-    destinationRequisitionListUid: $destinationRequisitionListUid,
-    requisitionListItem: $requisitionListItem
-  ) {
-    requisition_list {
-      ...RequisitionListFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{
-  "sourceRequisitionListUid": 4,
-  "destinationRequisitionListUid": "4",
-  "requisitionListItem": CopyItemsBetweenRequisitionListsInput
-}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "copyItemsBetweenRequisitionLists": {
-      "requisition_list": RequisitionList
-    }
-  }
-}
-
- -
-
-
-
-
-
- Mutations -
-

copyProductsBetweenWishlists

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns a - 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
- - - 
mutation copyProductsBetweenWishlists(
-  $sourceWishlistUid: ID!,
-  $destinationWishlistUid: ID!,
-  $wishlistItems: [WishlistItemCopyInput!]!
-) {
-  copyProductsBetweenWishlists(
-    sourceWishlistUid: $sourceWishlistUid,
-    destinationWishlistUid: $destinationWishlistUid,
-    wishlistItems: $wishlistItems
-  ) {
-    destination_wishlist {
-      ...WishlistFragment
-    }
-    source_wishlist {
-      ...WishlistFragment
-    }
-    user_errors {
-      ...WishListUserInputErrorFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{
-  "sourceWishlistUid": "4",
-  "destinationWishlistUid": 4,
-  "wishlistItems": [WishlistItemCopyInput]
-}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "copyProductsBetweenWishlists": {
-      "destination_wishlist": Wishlist,
-      "source_wishlist": Wishlist,
-      "user_errors": [WishListUserInputError]
-    }
-  }
-}
-
- -
-
-
-
-
-
- Mutations -
-

createBraintreeClientToken

-
-
-
-
Description
-

Creates Client Token for Braintree Javascript SDK initialization.

-
-
-
-
-
-
-
Response
-

Returns a - String! -

-
-
-
-

Example

-
-
Query
- - - 
mutation createBraintreeClientToken {
-  createBraintreeClientToken
-}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "createBraintreeClientToken": "xyz789"
-  }
-}
-
- -
-
-
-
-
-
- Mutations -
-

createCompany

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns a - CreateCompanyOutput -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- input - - - CompanyCreateInput! - -
-
-
-
-

Example

-
-
Query
- - - 
mutation createCompany($input: CompanyCreateInput!) {
-  createCompany(input: $input) {
-    company {
-      ...CompanyFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": CompanyCreateInput}
-
- -
-
-
Response
- - - 
{"data": {"createCompany": {"company": Company}}}
-
- -
-
-
-
-
-
- Mutations -
-

createCompanyRole

-
-
-
-
Description
-

Create a new company role.

-
-
-
-
-
-
-
Response
-

Returns a - CreateCompanyRoleOutput -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- input - - - CompanyRoleCreateInput! - -
-
-
-
-

Example

-
-
Query
- - - 
mutation createCompanyRole($input: CompanyRoleCreateInput!) {
-  createCompanyRole(input: $input) {
-    role {
-      ...CompanyRoleFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": CompanyRoleCreateInput}
-
- -
-
-
Response
- - - 
{"data": {"createCompanyRole": {"role": CompanyRole}}}
-
- -
-
-
-
-
-
- Mutations -
-

createCompanyTeam

-
-
-
-
Description
-

Create a new team for the authenticated customer's company.

-
-
-
-
-
-
-
Response
-

Returns a - CreateCompanyTeamOutput -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- input - - - CompanyTeamCreateInput! - -
-
-
-
-

Example

-
-
Query
- - - 
mutation createCompanyTeam($input: CompanyTeamCreateInput!) {
-  createCompanyTeam(input: $input) {
-    team {
-      ...CompanyTeamFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": CompanyTeamCreateInput}
-
- -
-
-
Response
- - - 
{"data": {"createCompanyTeam": {"team": CompanyTeam}}}
-
- -
-
-
-
-
-
- Mutations -
-

createCompanyUser

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns a - CreateCompanyUserOutput -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- input - - - CompanyUserCreateInput! - -
-
-
-
-

Example

-
-
Query
- - - 
mutation createCompanyUser($input: CompanyUserCreateInput!) {
-  createCompanyUser(input: $input) {
-    user {
-      ...CustomerFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": CompanyUserCreateInput}
-
- -
-
-
Response
- - - 
{"data": {"createCompanyUser": {"user": Customer}}}
-
- -
-
-
-
-
-
- Mutations -
-

createCompareList

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns a - CompareList -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- input - - - CreateCompareListInput - -
-
-
-
-

Example

-
-
Query
- - - 
mutation createCompareList($input: CreateCompareListInput) {
-  createCompareList(input: $input) {
-    attributes {
-      ...ComparableAttributeFragment
-    }
-    item_count
-    items {
-      ...ComparableItemFragment
-    }
-    uid
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": CreateCompareListInput}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "createCompareList": {
-      "attributes": [ComparableAttribute],
-      "item_count": 123,
-      "items": [ComparableItem],
-      "uid": 4
-    }
-  }
-}
-
- -
-
-
-
-
-
- Mutations -
-

createCustomer

-
-
-
-
Description
-

Use createCustomerV2 instead.

-
-
-
-
-
-
-
Response
-

Returns a - CustomerOutput -

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

Example

-
-
Query
- - - 
mutation createCustomer($input: CustomerInput!) {
-  createCustomer(input: $input) {
-    customer {
-      ...CustomerFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": CustomerInput}
-
- -
-
-
Response
- - - 
{"data": {"createCustomer": {"customer": Customer}}}
-
- -
-
-
-
-
-
- Mutations -
-

createCustomerAddress

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns a - CustomerAddress -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- input - - - CustomerAddressInput! - -
-
-
-
-

Example

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

createCustomerV2

-
-
-
-
Description
-

Create a customer account.

-
-
-
-
-
-
-
Response
-

Returns a - CustomerOutput -

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

Example

-
-
Query
- - - 
mutation createCustomerV2($input: CustomerCreateInput!) {
-  createCustomerV2(input: $input) {
-    customer {
-      ...CustomerFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": CustomerCreateInput}
-
- -
-
-
Response
- - - 
{"data": {"createCustomerV2": {"customer": Customer}}}
-
- -
-
-
-
-
-
- Mutations -
-

createEmptyCart

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns a - String -

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

Example

-
-
Query
- - - 
mutation createEmptyCart($input: createEmptyCartInput) {
-  createEmptyCart(input: $input)
-}
-
- -
-
-
Variables
- - - 
{"input": createEmptyCartInput}
-
- -
-
-
Response
- - - 
{"data": {"createEmptyCart": "xyz789"}}
-
- -
-
-
-
-
-
- Mutations -
-

createGiftRegistry

-
-
-
-
Description
-

Create a gift registry on behalf of the customer.

-
-
-
-
-
-
-
Response
-

Returns a - CreateGiftRegistryOutput -

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

Example

-
-
Query
- - - 
mutation createGiftRegistry($giftRegistry: CreateGiftRegistryInput!) {
-  createGiftRegistry(giftRegistry: $giftRegistry) {
-    gift_registry {
-      ...GiftRegistryFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"giftRegistry": CreateGiftRegistryInput}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "createGiftRegistry": {"gift_registry": GiftRegistry}
-  }
-}
-
- -
-
-
-
-
-
- Mutations -
-

createPayflowProToken

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns a - CreatePayflowProTokenOutput -

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

Example

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

createPaypalExpressToken

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns a - PaypalExpressTokenOutput -

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

Example

-
-
Query
- - - 
mutation createPaypalExpressToken($input: PaypalExpressTokenInput!) {
-  createPaypalExpressToken(input: $input) {
-    paypal_urls {
-      ...PaypalExpressUrlListFragment
-    }
-    token
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": PaypalExpressTokenInput}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "createPaypalExpressToken": {
-      "paypal_urls": PaypalExpressUrlList,
-      "token": "xyz789"
-    }
-  }
-}
-
- -
-
-
-
-
-
- Mutations -
-

createProductReview

-
-
-
-
Description
-

Create a product review for the specified product.

-
-
-
-
-
-
-
Response
-

Returns a - CreateProductReviewOutput! -

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

Example

-
-
Query
- - - 
mutation createProductReview($input: CreateProductReviewInput!) {
-  createProductReview(input: $input) {
-    review {
-      ...ProductReviewFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": CreateProductReviewInput}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "createProductReview": {"review": ProductReview}
-  }
-}
-
- -
-
-
-
-
-
- Mutations -
-

createPurchaseOrderApprovalRule

-
-
-
-
Description
-

Create a purchase order approval rule.

-
-
-
-
-
-
-
Response
-

Returns a - PurchaseOrderApprovalRule -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- input - - - PurchaseOrderApprovalRuleInput! - -
-
-
-
-

Example

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

createRequisitionList

-
-
-
-
Description
-

Create an empty requisition list.

-
-
-
-
-
-
-
Response
-

Returns a - CreateRequisitionListOutput -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- input - - - CreateRequisitionListInput - -
-
-
-
-

Example

-
-
Query
- - - 
mutation createRequisitionList($input: CreateRequisitionListInput) {
-  createRequisitionList(input: $input) {
-    requisition_list {
-      ...RequisitionListFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": CreateRequisitionListInput}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "createRequisitionList": {
-      "requisition_list": RequisitionList
-    }
-  }
-}
-
- -
-
-
-
-
-
- Mutations -
-

createWishlist

-
-
-
-
Description
-

Create a new wish list.

-
-
-
-
-
-
-
Response
-

Returns a - CreateWishlistOutput -

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

Example

-
-
Query
- - - 
mutation createWishlist($input: CreateWishlistInput!) {
-  createWishlist(input: $input) {
-    wishlist {
-      ...WishlistFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": CreateWishlistInput}
-
- -
-
-
Response
- - - 
{"data": {"createWishlist": {"wishlist": Wishlist}}}
-
- -
-
-
-
-
-
- Mutations -
-

deleteCompanyRole

-
-
-
-
Description
-

Delete the specified company role.

-
-
-
-
-
-
-
Response
-

Returns a - DeleteCompanyRoleOutput -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- id - - - ID! - -
-
-
-
-

Example

-
-
Query
- - - 
mutation deleteCompanyRole($id: ID!) {
-  deleteCompanyRole(id: $id) {
-    success
-  }
-}
-
- -
-
-
Variables
- - - 
{"id": "4"}
-
- -
-
-
Response
- - - 
{"data": {"deleteCompanyRole": {"success": true}}}
-
- -
-
-
-
-
-
- Mutations -
-

deleteCompanyTeam

-
-
-
-
Description
-

Delete the specified company team.

-
-
-
-
-
-
-
Response
-

Returns a - DeleteCompanyTeamOutput -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- id - - - ID! - -
-
-
-
-

Example

-
-
Query
- - - 
mutation deleteCompanyTeam($id: ID!) {
-  deleteCompanyTeam(id: $id) {
-    success
-  }
-}
-
- -
-
-
Variables
- - - 
{"id": 4}
-
- -
-
-
Response
- - - 
{"data": {"deleteCompanyTeam": {"success": true}}}
-
- -
-
-
-
-
-
- Mutations -
-

deleteCompanyUser

-
-
-
-
Description
-

Delete the specified company user.

-
-
-
-
-
-
-
Response
-

Returns a - DeleteCompanyUserOutput -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- id - - - ID! - -
-
-
-
-

Example

-
-
Query
- - - 
mutation deleteCompanyUser($id: ID!) {
-  deleteCompanyUser(id: $id) {
-    success
-  }
-}
-
- -
-
-
Variables
- - - 
{"id": 4}
-
- -
-
-
Response
- - - 
{"data": {"deleteCompanyUser": {"success": true}}}
-
- -
-
-
-
-
-
- Mutations -
-

deleteCompareList

-
-
-
-
Description
-

Delete the specified compare list.

-
-
-
-
-
-
-
Response
-

Returns a - DeleteCompareListOutput -

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

Example

-
-
Query
- - - 
mutation deleteCompareList($uid: ID!) {
-  deleteCompareList(uid: $uid) {
-    result
-  }
-}
-
- -
-
-
Variables
- - - 
{"uid": "4"}
-
- -
-
-
Response
- - - 
{"data": {"deleteCompareList": {"result": false}}}
-
- -
-
-
-
-
-
- Mutations -
-

deleteCustomer

-
-
-
-
Description
-

Delete customer account

-
-
-
-
-
-
-
Response
-

Returns a - Boolean -

-
-
-
-

Example

-
-
Query
- - - 
mutation deleteCustomer {
-  deleteCustomer
-}
-
- -
-
-
Response
- - - 
{"data": {"deleteCustomer": false}}
-
- -
-
-
-
-
-
- Mutations -
-

deleteCustomerAddress

-
-
-
-
Description
-

Delete the billing or shipping address of a customer.

-
-
-
-
-
-
-
Response
-

Returns a - Boolean -

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

Example

-
-
Query
- - - 
mutation deleteCustomerAddress($id: Int!) {
-  deleteCustomerAddress(id: $id)
-}
-
- -
-
-
Variables
- - - 
{"id": 123}
-
- -
-
-
Response
- - - 
{"data": {"deleteCustomerAddress": false}}
-
- -
-
-
-
-
-
- Mutations -
-

deleteNegotiableQuotes

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns a - DeleteNegotiableQuotesOutput -

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

Example

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

deletePaymentToken

-
-
-
-
Description
-

Delete a customer's payment token.

-
-
-
-
-
-
-
Response
-

Returns a - DeletePaymentTokenOutput -

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

Example

-
-
Query
- - - 
mutation deletePaymentToken($public_hash: String!) {
-  deletePaymentToken(public_hash: $public_hash) {
-    customerPaymentTokens {
-      ...CustomerPaymentTokensFragment
-    }
-    result
-  }
-}
-
- -
-
-
Variables
- - - 
{"public_hash": "xyz789"}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "deletePaymentToken": {
-      "customerPaymentTokens": CustomerPaymentTokens,
-      "result": false
-    }
-  }
-}
-
- -
-
-
-
-
-
- Mutations -
-

deletePurchaseOrderApprovalRule

-
-
-
-
Description
-

Delete existing purchase order approval rules.

-
-
-
-
-
-
-
Response
-

Returns a - DeletePurchaseOrderApprovalRuleOutput -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- input - - - DeletePurchaseOrderApprovalRuleInput! - -
-
-
-
-

Example

-
-
Query
- - - 
mutation deletePurchaseOrderApprovalRule($input: DeletePurchaseOrderApprovalRuleInput!) {
-  deletePurchaseOrderApprovalRule(input: $input) {
-    errors {
-      ...DeletePurchaseOrderApprovalRuleErrorFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": DeletePurchaseOrderApprovalRuleInput}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "deletePurchaseOrderApprovalRule": {
-      "errors": [DeletePurchaseOrderApprovalRuleError]
-    }
-  }
-}
-
- -
-
-
-
-
-
- Mutations -
-

deleteRequisitionList

-
-
-
-
Description
-

Delete a requisition list.

-
-
-
-
-
-
-
Response
-

Returns a - DeleteRequisitionListOutput -

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

Example

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

deleteRequisitionListItems

-
-
-
-
Description
-

Delete items from a requisition list.

-
-
-
-
-
-
-
Response
-

Returns a - 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
- - - 
mutation deleteRequisitionListItems(
-  $requisitionListUid: ID!,
-  $requisitionListItemUids: [ID!]!
-) {
-  deleteRequisitionListItems(
-    requisitionListUid: $requisitionListUid,
-    requisitionListItemUids: $requisitionListItemUids
-  ) {
-    requisition_list {
-      ...RequisitionListFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{
-  "requisitionListUid": "4",
-  "requisitionListItemUids": ["4"]
-}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "deleteRequisitionListItems": {
-      "requisition_list": RequisitionList
-    }
-  }
-}
-
- -
-
-
-
-
-
- Mutations -
-

deleteWishlist

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns a - DeleteWishlistOutput -

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

Example

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

generateCustomerToken

-
-
-
-
Description
-

Generate a token for specified customer.

-
-
-
-
-
-
-
Response
-

Returns a - CustomerToken -

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

Example

-
-
Query
- - - 
mutation generateCustomerToken(
-  $email: String!,
-  $password: String!
-) {
-  generateCustomerToken(
-    email: $email,
-    password: $password
-  ) {
-    token
-  }
-}
-
- -
-
-
Variables
- - - 
{
-  "email": "xyz789",
-  "password": "abc123"
-}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "generateCustomerToken": {
-      "token": "xyz789"
-    }
-  }
-}
-
- -
-
-
-
-
-
- Mutations -
-

generateCustomerTokenAsAdmin

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns a - GenerateCustomerTokenAsAdminOutput -

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

Example

-
-
Query
- - - 
mutation generateCustomerTokenAsAdmin($input: GenerateCustomerTokenAsAdminInput!) {
-  generateCustomerTokenAsAdmin(input: $input) {
-    customer_token
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": GenerateCustomerTokenAsAdminInput}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "generateCustomerTokenAsAdmin": {
-      "customer_token": "xyz789"
-    }
-  }
-}
-
- -
-
-
-
-
-
- Mutations -
-

handlePayflowProResponse

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns a - PayflowProResponseOutput -

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

Example

-
-
Query
- - - 
mutation handlePayflowProResponse($input: PayflowProResponseInput!) {
-  handlePayflowProResponse(input: $input) {
-    cart {
-      ...CartFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": PayflowProResponseInput}
-
- -
-
-
Response
- - - 
{"data": {"handlePayflowProResponse": {"cart": Cart}}}
-
- -
-
-
-
-
-
- Mutations -
-

mergeCarts

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns a - 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
- - - 
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
-    }
-    prices {
-      ...CartPricesFragment
-    }
-    printed_card_included
-    selected_payment_method {
-      ...SelectedPaymentMethodFragment
-    }
-    shipping_addresses {
-      ...ShippingCartAddressFragment
-    }
-    total_quantity
-  }
-}
-
- -
-
-
Variables
- - - 
{
-  "source_cart_id": "xyz789",
-  "destination_cart_id": "xyz789"
-}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "mergeCarts": {
-      "applied_coupon": AppliedCoupon,
-      "applied_coupons": [AppliedCoupon],
-      "applied_gift_cards": [AppliedGiftCard],
-      "applied_reward_points": RewardPointsAmount,
-      "applied_store_credit": AppliedStoreCredit,
-      "available_gift_wrappings": [GiftWrapping],
-      "available_payment_methods": [
-        AvailablePaymentMethod
-      ],
-      "billing_address": BillingCartAddress,
-      "email": "abc123",
-      "gift_message": GiftMessage,
-      "gift_receipt_included": true,
-      "gift_wrapping": GiftWrapping,
-      "id": 4,
-      "is_virtual": true,
-      "items": [CartItemInterface],
-      "prices": CartPrices,
-      "printed_card_included": true,
-      "selected_payment_method": SelectedPaymentMethod,
-      "shipping_addresses": [ShippingCartAddress],
-      "total_quantity": 123.45
-    }
-  }
-}
-
- -
-
-
-
-
-
- Mutations -
-

moveCartItemsToGiftRegistry

-
-
-
-
Description
-

Move all items from the cart to a gift registry.

-
-
-
-
-
-
-
Response
-

Returns a - 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
- - - 
mutation moveCartItemsToGiftRegistry(
-  $cartUid: ID!,
-  $giftRegistryUid: ID!
-) {
-  moveCartItemsToGiftRegistry(
-    cartUid: $cartUid,
-    giftRegistryUid: $giftRegistryUid
-  ) {
-    gift_registry {
-      ...GiftRegistryFragment
-    }
-    status
-    user_errors {
-      ...GiftRegistryItemsUserErrorFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"cartUid": 4, "giftRegistryUid": 4}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "moveCartItemsToGiftRegistry": {
-      "gift_registry": GiftRegistry,
-      "status": true,
-      "user_errors": [GiftRegistryItemsUserError]
-    }
-  }
-}
-
- -
-
-
-
-
-
- Mutations -
-

moveItemsBetweenRequisitionLists

-
-
-
-
Description
-

Move Items from one requisition list to another.

-
-
-
-
-
-
-
Response
-

Returns a - 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
- - - 
mutation moveItemsBetweenRequisitionLists(
-  $sourceRequisitionListUid: ID!,
-  $destinationRequisitionListUid: ID,
-  $requisitionListItem: MoveItemsBetweenRequisitionListsInput
-) {
-  moveItemsBetweenRequisitionLists(
-    sourceRequisitionListUid: $sourceRequisitionListUid,
-    destinationRequisitionListUid: $destinationRequisitionListUid,
-    requisitionListItem: $requisitionListItem
-  ) {
-    destination_requisition_list {
-      ...RequisitionListFragment
-    }
-    source_requisition_list {
-      ...RequisitionListFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{
-  "sourceRequisitionListUid": 4,
-  "destinationRequisitionListUid": "4",
-  "requisitionListItem": MoveItemsBetweenRequisitionListsInput
-}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "moveItemsBetweenRequisitionLists": {
-      "destination_requisition_list": RequisitionList,
-      "source_requisition_list": RequisitionList
-    }
-  }
-}
-
- -
-
-
-
-
-
- Mutations -
-

moveProductsBetweenWishlists

-
-
-
-
Description
-

Move products from one wish list to another.

-
-
-
-
-
-
-
Response
-

Returns a - 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
- - - 
mutation moveProductsBetweenWishlists(
-  $sourceWishlistUid: ID!,
-  $destinationWishlistUid: ID!,
-  $wishlistItems: [WishlistItemMoveInput!]!
-) {
-  moveProductsBetweenWishlists(
-    sourceWishlistUid: $sourceWishlistUid,
-    destinationWishlistUid: $destinationWishlistUid,
-    wishlistItems: $wishlistItems
-  ) {
-    destination_wishlist {
-      ...WishlistFragment
-    }
-    source_wishlist {
-      ...WishlistFragment
-    }
-    user_errors {
-      ...WishListUserInputErrorFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{
-  "sourceWishlistUid": 4,
-  "destinationWishlistUid": "4",
-  "wishlistItems": [WishlistItemMoveInput]
-}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "moveProductsBetweenWishlists": {
-      "destination_wishlist": Wishlist,
-      "source_wishlist": Wishlist,
-      "user_errors": [WishListUserInputError]
-    }
-  }
-}
-
- -
-
-
-
-
-
- Mutations -
-

placeNegotiableQuoteOrder

-
-
-
-
Description
-

Convert a negotiable quote into an order.

-
-
-
-
-
-
-
Response
-

Returns a - PlaceNegotiableQuoteOrderOutput -

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

Example

-
-
Query
- - - 
mutation placeNegotiableQuoteOrder($input: PlaceNegotiableQuoteOrderInput!) {
-  placeNegotiableQuoteOrder(input: $input) {
-    order {
-      ...OrderFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": PlaceNegotiableQuoteOrderInput}
-
- -
-
-
Response
- - - 
{"data": {"placeNegotiableQuoteOrder": {"order": Order}}}
-
- -
-
-
-
-
-
- Mutations -
-

placeOrder

-
-
-
-
Description
-

Convert the quote into an order.

-
-
-
-
-
-
-
Response
-

Returns a - PlaceOrderOutput -

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

Example

-
-
Query
- - - 
mutation placeOrder($input: PlaceOrderInput) {
-  placeOrder(input: $input) {
-    order {
-      ...OrderFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": PlaceOrderInput}
-
- -
-
-
Response
- - - 
{"data": {"placeOrder": {"order": Order}}}
-
- -
-
-
-
-
-
- Mutations -
-

placeOrderForPurchaseOrder

-
-
-
-
Description
-

Convert the purchase order into an order.

-
-
-
-
-
-
-
Response
-

Returns a - PlaceOrderForPurchaseOrderOutput -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- input - - - PlaceOrderForPurchaseOrderInput! - -
-
-
-
-

Example

-
-
Query
- - - 
mutation placeOrderForPurchaseOrder($input: PlaceOrderForPurchaseOrderInput!) {
-  placeOrderForPurchaseOrder(input: $input) {
-    order {
-      ...CustomerOrderFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": PlaceOrderForPurchaseOrderInput}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "placeOrderForPurchaseOrder": {"order": CustomerOrder}
-  }
-}
-
- -
-
-
-
-
-
- Mutations -
-

placePurchaseOrder

-
-
-
-
Description
-

Place a purchase order.

-
-
-
-
-
-
-
Response
-

Returns a - PlacePurchaseOrderOutput -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- input - - - PlacePurchaseOrderInput! - -
-
-
-
-

Example

-
-
Query
- - - 
mutation placePurchaseOrder($input: PlacePurchaseOrderInput!) {
-  placePurchaseOrder(input: $input) {
-    purchase_order {
-      ...PurchaseOrderFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": PlacePurchaseOrderInput}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "placePurchaseOrder": {
-      "purchase_order": PurchaseOrder
-    }
-  }
-}
-
- -
-
-
-
-
-
- Mutations -
-

redeemGiftCardBalanceAsStoreCredit

-
-
-
-
Description
-

Redeem a gift card for store credit.

-
-
-
-
-
-
-
Response
-

Returns a - GiftCardAccount -

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

Example

-
-
Query
- - - 
mutation redeemGiftCardBalanceAsStoreCredit($input: GiftCardAccountInput!) {
-  redeemGiftCardBalanceAsStoreCredit(input: $input) {
-    balance {
-      ...MoneyFragment
-    }
-    code
-    expiration_date
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": GiftCardAccountInput}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "redeemGiftCardBalanceAsStoreCredit": {
-      "balance": Money,
-      "code": "abc123",
-      "expiration_date": "abc123"
-    }
-  }
-}
-
- -
-
-
-
-
-
- Mutations -
-

rejectPurchaseOrders

-
-
-
-
Description
-

Reject purchase orders.

-
-
-
-
-
-
-
Response
-

Returns a - PurchaseOrdersActionOutput -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- input - - - PurchaseOrdersActionInput! - -
-
-
-
-

Example

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

removeCouponFromCart

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns a - RemoveCouponFromCartOutput -

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

Example

-
-
Query
- - - 
mutation removeCouponFromCart($input: RemoveCouponFromCartInput) {
-  removeCouponFromCart(input: $input) {
-    cart {
-      ...CartFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": RemoveCouponFromCartInput}
-
- -
-
-
Response
- - - 
{"data": {"removeCouponFromCart": {"cart": Cart}}}
-
- -
-
-
-
-
-
- Mutations -
-

removeGiftCardFromCart

-
-
-
-
Description
-

Removes a gift card from the cart.

-
-
-
-
-
-
-
Response
-

Returns a - RemoveGiftCardFromCartOutput -

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

Example

-
-
Query
- - - 
mutation removeGiftCardFromCart($input: RemoveGiftCardFromCartInput) {
-  removeGiftCardFromCart(input: $input) {
-    cart {
-      ...CartFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": RemoveGiftCardFromCartInput}
-
- -
-
-
Response
- - - 
{"data": {"removeGiftCardFromCart": {"cart": Cart}}}
-
- -
-
-
-
-
-
- Mutations -
-

removeGiftRegistry

-
-
-
-
Description
-

Delete the specified gift registry.

-
-
-
-
-
-
-
Response
-

Returns a - RemoveGiftRegistryOutput -

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

Example

-
-
Query
- - - 
mutation removeGiftRegistry($giftRegistryUid: ID!) {
-  removeGiftRegistry(giftRegistryUid: $giftRegistryUid) {
-    success
-  }
-}
-
- -
-
-
Variables
- - - 
{"giftRegistryUid": "4"}
-
- -
-
-
Response
- - - 
{"data": {"removeGiftRegistry": {"success": true}}}
-
- -
-
-
-
-
-
- Mutations -
-

removeGiftRegistryItems

-
-
-
-
Description
-

Delete the specified items from a gift registry.

-
-
-
-
-
-
-
Response
-

Returns a - 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
- - - 
mutation removeGiftRegistryItems(
-  $giftRegistryUid: ID!,
-  $itemsUid: [ID!]!
-) {
-  removeGiftRegistryItems(
-    giftRegistryUid: $giftRegistryUid,
-    itemsUid: $itemsUid
-  ) {
-    gift_registry {
-      ...GiftRegistryFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"giftRegistryUid": "4", "itemsUid": [4]}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "removeGiftRegistryItems": {
-      "gift_registry": GiftRegistry
-    }
-  }
-}
-
- -
-
-
-
-
-
- Mutations -
-

removeGiftRegistryRegistrants

-
-
-
-
Description
-

Removes registrants from a gift registry.

-
-
-
-
-
-
-
Response
-

Returns a - RemoveGiftRegistryRegistrantsOutput -

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

Example

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

removeItemFromCart

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns a - RemoveItemFromCartOutput -

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

Example

-
-
Query
- - - 
mutation removeItemFromCart($input: RemoveItemFromCartInput) {
-  removeItemFromCart(input: $input) {
-    cart {
-      ...CartFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": RemoveItemFromCartInput}
-
- -
-
-
Response
- - - 
{"data": {"removeItemFromCart": {"cart": Cart}}}
-
- -
-
-
-
-
-
- Mutations -
-

removeNegotiableQuoteItems

-
-
-
-
Description
-

Remove one or more products from a negotiable quote.

-
-
-
-
-
-
-
Response
-

Returns a - RemoveNegotiableQuoteItemsOutput -

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

Example

-
-
Query
- - - 
mutation removeNegotiableQuoteItems($input: RemoveNegotiableQuoteItemsInput!) {
-  removeNegotiableQuoteItems(input: $input) {
-    quote {
-      ...NegotiableQuoteFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": RemoveNegotiableQuoteItemsInput}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "removeNegotiableQuoteItems": {
-      "quote": NegotiableQuote
-    }
-  }
-}
-
- -
-
-
-
-
-
- Mutations -
-

removeProductsFromCompareList

-
-
-
-
Description
-

Remove products from the specified compare list.

-
-
-
-
-
-
-
Response
-

Returns a - CompareList -

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

Example

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

removeProductsFromWishlist

-
-
-
-
Description
-

Remove one or more products from the specified wish list.

-
-
-
-
-
-
-
Response
-

Returns a - 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
- - - 
mutation removeProductsFromWishlist(
-  $wishlistId: ID!,
-  $wishlistItemsIds: [ID!]!
-) {
-  removeProductsFromWishlist(
-    wishlistId: $wishlistId,
-    wishlistItemsIds: $wishlistItemsIds
-  ) {
-    user_errors {
-      ...WishListUserInputErrorFragment
-    }
-    wishlist {
-      ...WishlistFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"wishlistId": "4", "wishlistItemsIds": [4]}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "removeProductsFromWishlist": {
-      "user_errors": [WishListUserInputError],
-      "wishlist": Wishlist
-    }
-  }
-}
-
- -
-
-
-
-
-
- Mutations -
-

removeReturnTracking

-
-
-
-
Description
-

Remove a tracked shipment from a return.

-
-
-
-
-
-
-
Response
-

Returns a - RemoveReturnTrackingOutput -

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

Example

-
-
Query
- - - 
mutation removeReturnTracking($input: RemoveReturnTrackingInput!) {
-  removeReturnTracking(input: $input) {
-    return {
-      ...ReturnFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": RemoveReturnTrackingInput}
-
- -
-
-
Response
- - - 
{"data": {"removeReturnTracking": {"return": Return}}}
-
- -
-
-
-
-
-
- Mutations -
-

removeRewardPointsFromCart

-
-
-
-
Description
-

Cancel the application of reward points to the cart.

-
-
-
-
-
-
-
Response
-

Returns a - RemoveRewardPointsFromCartOutput -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- cartId - - - ID! - -
-
-
-
-

Example

-
-
Query
- - - 
mutation removeRewardPointsFromCart($cartId: ID!) {
-  removeRewardPointsFromCart(cartId: $cartId) {
-    cart {
-      ...CartFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"cartId": "4"}
-
- -
-
-
Response
- - - 
{"data": {"removeRewardPointsFromCart": {"cart": Cart}}}
-
- -
-
-
-
-
-
- Mutations -
-

removeStoreCreditFromCart

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns a - RemoveStoreCreditFromCartOutput -

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

Example

-
-
Query
- - - 
mutation removeStoreCreditFromCart($input: RemoveStoreCreditFromCartInput!) {
-  removeStoreCreditFromCart(input: $input) {
-    cart {
-      ...CartFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": RemoveStoreCreditFromCartInput}
-
- -
-
-
Response
- - - 
{"data": {"removeStoreCreditFromCart": {"cart": Cart}}}
-
- -
-
-
-
-
-
- Mutations -
-

reorderItems

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns a - ReorderItemsOutput -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- orderNumber - - - String! - -
-
-
-
-

Example

-
-
Query
- - - 
mutation reorderItems($orderNumber: String!) {
-  reorderItems(orderNumber: $orderNumber) {
-    cart {
-      ...CartFragment
-    }
-    userInputErrors {
-      ...CheckoutUserInputErrorFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"orderNumber": "abc123"}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "reorderItems": {
-      "cart": Cart,
-      "userInputErrors": [CheckoutUserInputError]
-    }
-  }
-}
-
- -
-
-
-
-
-
- Mutations -
-

requestNegotiableQuote

-
-
-
-
Description
-

Request a new negotiable quote on behalf of the buyer.

-
-
-
-
-
-
-
Response
-

Returns a - RequestNegotiableQuoteOutput -

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

Example

-
-
Query
- - - 
mutation requestNegotiableQuote($input: RequestNegotiableQuoteInput!) {
-  requestNegotiableQuote(input: $input) {
-    quote {
-      ...NegotiableQuoteFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": RequestNegotiableQuoteInput}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "requestNegotiableQuote": {"quote": NegotiableQuote}
-  }
-}
-
- -
-
-
-
-
-
- Mutations -
-

requestPasswordResetEmail

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns a - Boolean -

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

Example

-
-
Query
- - - 
mutation requestPasswordResetEmail($email: String!) {
-  requestPasswordResetEmail(email: $email)
-}
-
- -
-
-
Variables
- - - 
{"email": "xyz789"}
-
- -
-
-
Response
- - - 
{"data": {"requestPasswordResetEmail": false}}
-
- -
-
-
-
-
-
- Mutations -
-

requestReturn

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns a - RequestReturnOutput -

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

Example

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

resetPassword

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns a - Boolean -

-
-
-
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
- - - 
mutation resetPassword(
-  $email: String!,
-  $resetPasswordToken: String!,
-  $newPassword: String!
-) {
-  resetPassword(
-    email: $email,
-    resetPasswordToken: $resetPasswordToken,
-    newPassword: $newPassword
-  )
-}
-
- -
-
-
Variables
- - - 
{
-  "email": "xyz789",
-  "resetPasswordToken": "xyz789",
-  "newPassword": "xyz789"
-}
-
- -
-
-
Response
- - - 
{"data": {"resetPassword": true}}
-
- -
-
-
-
-
-
- Mutations -
-

revokeCustomerToken

-
-
-
-
Description
-

Revoke the customer token.

-
-
-
-
-
-
-
Response
-

Returns a - RevokeCustomerTokenOutput -

-
-
-
-

Example

-
-
Query
- - - 
mutation revokeCustomerToken {
-  revokeCustomerToken {
-    result
-  }
-}
-
- -
-
-
Response
- - - 
{"data": {"revokeCustomerToken": {"result": true}}}
-
- -
-
-
-
-
-
- Mutations -
-

sendEmailToFriend

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns a - SendEmailToFriendOutput -

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

Example

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

sendNegotiableQuoteForReview

-
-
-
-
Description
-

Send the negotiable quote to the seller for review.

-
-
-
-
-
-
-
Response
-

Returns a - SendNegotiableQuoteForReviewOutput -

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

Example

-
-
Query
- - - 
mutation sendNegotiableQuoteForReview($input: SendNegotiableQuoteForReviewInput!) {
-  sendNegotiableQuoteForReview(input: $input) {
-    quote {
-      ...NegotiableQuoteFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": SendNegotiableQuoteForReviewInput}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "sendNegotiableQuoteForReview": {
-      "quote": NegotiableQuote
-    }
-  }
-}
-
- -
-
-
-
-
-
- Mutations -
-

setBillingAddressOnCart

-
-
-
-
Description
-

Set the billing address on a specific cart.

-
-
-
-
-
-
-
Response
-

Returns a - SetBillingAddressOnCartOutput -

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

Example

-
-
Query
- - - 
mutation setBillingAddressOnCart($input: SetBillingAddressOnCartInput) {
-  setBillingAddressOnCart(input: $input) {
-    cart {
-      ...CartFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": SetBillingAddressOnCartInput}
-
- -
-
-
Response
- - - 
{"data": {"setBillingAddressOnCart": {"cart": Cart}}}
-
- -
-
-
-
-
-
- Mutations -
-

setGiftOptionsOnCart

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns a - SetGiftOptionsOnCartOutput -

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

Example

-
-
Query
- - - 
mutation setGiftOptionsOnCart($input: SetGiftOptionsOnCartInput) {
-  setGiftOptionsOnCart(input: $input) {
-    cart {
-      ...CartFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": SetGiftOptionsOnCartInput}
-
- -
-
-
Response
- - - 
{"data": {"setGiftOptionsOnCart": {"cart": Cart}}}
-
- -
-
-
-
-
-
- Mutations -
-

setGuestEmailOnCart

-
-
-
-
Description
-

Assign the email address of a guest to the cart.

-
-
-
-
-
-
-
Response
-

Returns a - SetGuestEmailOnCartOutput -

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

Example

-
-
Query
- - - 
mutation setGuestEmailOnCart($input: SetGuestEmailOnCartInput) {
-  setGuestEmailOnCart(input: $input) {
-    cart {
-      ...CartFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": SetGuestEmailOnCartInput}
-
- -
-
-
Response
- - - 
{"data": {"setGuestEmailOnCart": {"cart": Cart}}}
-
- -
-
-
-
-
-
- Mutations -
-

setNegotiableQuoteBillingAddress

-
-
-
-
Description
-

Assign a billing address to a negotiable quote.

-
-
-
-
-
-
-
Response
-

Returns a - SetNegotiableQuoteBillingAddressOutput -

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

Example

-
-
Query
- - - 
mutation setNegotiableQuoteBillingAddress($input: SetNegotiableQuoteBillingAddressInput!) {
-  setNegotiableQuoteBillingAddress(input: $input) {
-    quote {
-      ...NegotiableQuoteFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": SetNegotiableQuoteBillingAddressInput}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "setNegotiableQuoteBillingAddress": {
-      "quote": NegotiableQuote
-    }
-  }
-}
-
- -
-
-
-
-
-
- Mutations -
-

setNegotiableQuotePaymentMethod

-
-
-
-
Description
-

Set the payment method on a negotiable quote.

-
-
-
-
-
-
-
Response
-

Returns a - SetNegotiableQuotePaymentMethodOutput -

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

Example

-
-
Query
- - - 
mutation setNegotiableQuotePaymentMethod($input: SetNegotiableQuotePaymentMethodInput!) {
-  setNegotiableQuotePaymentMethod(input: $input) {
-    quote {
-      ...NegotiableQuoteFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": SetNegotiableQuotePaymentMethodInput}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "setNegotiableQuotePaymentMethod": {
-      "quote": NegotiableQuote
-    }
-  }
-}
-
- -
-
-
-
-
-
- Mutations -
-

setNegotiableQuoteShippingAddress

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns a - SetNegotiableQuoteShippingAddressOutput -

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

Example

-
-
Query
- - - 
mutation setNegotiableQuoteShippingAddress($input: SetNegotiableQuoteShippingAddressInput!) {
-  setNegotiableQuoteShippingAddress(input: $input) {
-    quote {
-      ...NegotiableQuoteFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": SetNegotiableQuoteShippingAddressInput}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "setNegotiableQuoteShippingAddress": {
-      "quote": NegotiableQuote
-    }
-  }
-}
-
- -
-
-
-
-
-
- Mutations -
-

setNegotiableQuoteShippingMethods

-
-
-
-
Description
-

Assign the shipping methods on the negotiable quote.

-
-
-
-
-
-
-
Response
-

Returns a - SetNegotiableQuoteShippingMethodsOutput -

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

Example

-
-
Query
- - - 
mutation setNegotiableQuoteShippingMethods($input: SetNegotiableQuoteShippingMethodsInput!) {
-  setNegotiableQuoteShippingMethods(input: $input) {
-    quote {
-      ...NegotiableQuoteFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": SetNegotiableQuoteShippingMethodsInput}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "setNegotiableQuoteShippingMethods": {
-      "quote": NegotiableQuote
-    }
-  }
-}
-
- -
-
-
-
-
-
- Mutations -
-

setPaymentMethodAndPlaceOrder

-
-
-
-
Should use setPaymentMethodOnCart and placeOrder mutations in single request.
-
-
-
-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns a - PlaceOrderOutput -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- input - - - SetPaymentMethodAndPlaceOrderInput - -
-
-
-
-

Example

-
-
Query
- - - 
mutation setPaymentMethodAndPlaceOrder($input: SetPaymentMethodAndPlaceOrderInput) {
-  setPaymentMethodAndPlaceOrder(input: $input) {
-    order {
-      ...OrderFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": SetPaymentMethodAndPlaceOrderInput}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "setPaymentMethodAndPlaceOrder": {"order": Order}
-  }
-}
-
- -
-
-
-
-
-
- Mutations -
-

setPaymentMethodOnCart

-
-
-
-
Description
-

Apply a payment method to the cart.

-
-
-
-
-
-
-
Response
-

Returns a - SetPaymentMethodOnCartOutput -

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

Example

-
-
Query
- - - 
mutation setPaymentMethodOnCart($input: SetPaymentMethodOnCartInput) {
-  setPaymentMethodOnCart(input: $input) {
-    cart {
-      ...CartFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": SetPaymentMethodOnCartInput}
-
- -
-
-
Response
- - - 
{"data": {"setPaymentMethodOnCart": {"cart": Cart}}}
-
- -
-
-
-
-
-
- Mutations -
-

setShippingAddressesOnCart

-
-
-
-
Description
-

Set one or more shipping addresses on a specific cart.

-
-
-
-
-
-
-
Response
-

Returns a - SetShippingAddressesOnCartOutput -

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

Example

-
-
Query
- - - 
mutation setShippingAddressesOnCart($input: SetShippingAddressesOnCartInput) {
-  setShippingAddressesOnCart(input: $input) {
-    cart {
-      ...CartFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": SetShippingAddressesOnCartInput}
-
- -
-
-
Response
- - - 
{"data": {"setShippingAddressesOnCart": {"cart": Cart}}}
-
- -
-
-
-
-
-
- Mutations -
-

setShippingMethodsOnCart

-
-
-
-
Description
-

Set one or more delivery methods on a cart.

-
-
-
-
-
-
-
Response
-

Returns a - SetShippingMethodsOnCartOutput -

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

Example

-
-
Query
- - - 
mutation setShippingMethodsOnCart($input: SetShippingMethodsOnCartInput) {
-  setShippingMethodsOnCart(input: $input) {
-    cart {
-      ...CartFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": SetShippingMethodsOnCartInput}
-
- -
-
-
Response
- - - 
{"data": {"setShippingMethodsOnCart": {"cart": Cart}}}
-
- -
-
-
-
-
-
- Mutations -
-

shareGiftRegistry

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns a - 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
- - - 
mutation shareGiftRegistry(
-  $giftRegistryUid: ID!,
-  $sender: ShareGiftRegistrySenderInput!,
-  $invitees: [ShareGiftRegistryInviteeInput!]!
-) {
-  shareGiftRegistry(
-    giftRegistryUid: $giftRegistryUid,
-    sender: $sender,
-    invitees: $invitees
-  ) {
-    is_shared
-  }
-}
-
- -
-
-
Variables
- - - 
{
-  "giftRegistryUid": "4",
-  "sender": ShareGiftRegistrySenderInput,
-  "invitees": [ShareGiftRegistryInviteeInput]
-}
-
- -
-
-
Response
- - - 
{"data": {"shareGiftRegistry": {"is_shared": true}}}
-
- -
-
-
-
-
-
- Mutations -
-

subscribeEmailToNewsletter

-
-
-
-
Description
-

Subscribe the specified email to the store's newsletter.

-
-
-
-
-
-
-
Response
-

Returns a - SubscribeEmailToNewsletterOutput -

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

Example

-
-
Query
- - - 
mutation subscribeEmailToNewsletter($email: String!) {
-  subscribeEmailToNewsletter(email: $email) {
-    status
-  }
-}
-
- -
-
-
Variables
- - - 
{"email": "abc123"}
-
- -
-
-
Response
- - - 
{"data": {"subscribeEmailToNewsletter": {"status": "NOT_ACTIVE"}}}
-
- -
-
-
-
-
-
- Mutations -
-

updateCartItems

-
-
-
-
Description
-

Modify items in the cart.

-
-
-
-
-
-
-
Response
-

Returns an - UpdateCartItemsOutput -

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

Example

-
-
Query
- - - 
mutation updateCartItems($input: UpdateCartItemsInput) {
-  updateCartItems(input: $input) {
-    cart {
-      ...CartFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": UpdateCartItemsInput}
-
- -
-
-
Response
- - - 
{"data": {"updateCartItems": {"cart": Cart}}}
-
- -
-
-
-
-
-
- Mutations -
-

updateCompany

-
-
-
-
Description
-

Update company information.

-
-
-
-
-
-
-
Response
-

Returns an - UpdateCompanyOutput -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- input - - - CompanyUpdateInput! - -
-
-
-
-

Example

-
-
Query
- - - 
mutation updateCompany($input: CompanyUpdateInput!) {
-  updateCompany(input: $input) {
-    company {
-      ...CompanyFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": CompanyUpdateInput}
-
- -
-
-
Response
- - - 
{"data": {"updateCompany": {"company": Company}}}
-
- -
-
-
-
-
-
- Mutations -
-

updateCompanyRole

-
-
-
-
Description
-

Update company role information.

-
-
-
-
-
-
-
Response
-

Returns an - UpdateCompanyRoleOutput -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- input - - - CompanyRoleUpdateInput! - -
-
-
-
-

Example

-
-
Query
- - - 
mutation updateCompanyRole($input: CompanyRoleUpdateInput!) {
-  updateCompanyRole(input: $input) {
-    role {
-      ...CompanyRoleFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": CompanyRoleUpdateInput}
-
- -
-
-
Response
- - - 
{"data": {"updateCompanyRole": {"role": CompanyRole}}}
-
- -
-
-
-
-
-
- Mutations -
-

updateCompanyStructure

-
-
-
-
Description
-

Change the parent node of a company team.

-
-
-
-
-
-
-
Response
-

Returns an - UpdateCompanyStructureOutput -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- input - - - CompanyStructureUpdateInput! - -
-
-
-
-

Example

-
-
Query
- - - 
mutation updateCompanyStructure($input: CompanyStructureUpdateInput!) {
-  updateCompanyStructure(input: $input) {
-    company {
-      ...CompanyFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": CompanyStructureUpdateInput}
-
- -
-
-
Response
- - - 
{"data": {"updateCompanyStructure": {"company": Company}}}
-
- -
-
-
-
-
-
- Mutations -
-

updateCompanyTeam

-
-
-
-
Description
-

Update company team data.

-
-
-
-
-
-
-
Response
-

Returns an - UpdateCompanyTeamOutput -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- input - - - CompanyTeamUpdateInput! - -
-
-
-
-

Example

-
-
Query
- - - 
mutation updateCompanyTeam($input: CompanyTeamUpdateInput!) {
-  updateCompanyTeam(input: $input) {
-    team {
-      ...CompanyTeamFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": CompanyTeamUpdateInput}
-
- -
-
-
Response
- - - 
{"data": {"updateCompanyTeam": {"team": CompanyTeam}}}
-
- -
-
-
-
-
-
- Mutations -
-

updateCompanyUser

-
-
-
-
Description
-

Update an existing company user.

-
-
-
-
-
-
-
Response
-

Returns an - UpdateCompanyUserOutput -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- input - - - CompanyUserUpdateInput! - -
-
-
-
-

Example

-
-
Query
- - - 
mutation updateCompanyUser($input: CompanyUserUpdateInput!) {
-  updateCompanyUser(input: $input) {
-    user {
-      ...CustomerFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": CompanyUserUpdateInput}
-
- -
-
-
Response
- - - 
{"data": {"updateCompanyUser": {"user": Customer}}}
-
- -
-
-
-
-
-
- Mutations -
-

updateCustomer

-
-
-
-
Description
-

Use updateCustomerV2 instead.

-
-
-
-
-
-
-
Response
-

Returns a - CustomerOutput -

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

Example

-
-
Query
- - - 
mutation updateCustomer($input: CustomerInput!) {
-  updateCustomer(input: $input) {
-    customer {
-      ...CustomerFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": CustomerInput}
-
- -
-
-
Response
- - - 
{"data": {"updateCustomer": {"customer": Customer}}}
-
- -
-
-
-
-
-
- Mutations -
-

updateCustomerAddress

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns a - 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
- - - 
mutation updateCustomerAddress(
-  $id: Int!,
-  $input: CustomerAddressInput
-) {
-  updateCustomerAddress(
-    id: $id,
-    input: $input
-  ) {
-    city
-    company
-    country_code
-    country_id
-    custom_attributes {
-      ...CustomerAddressAttributeFragment
-    }
-    customer_id
-    default_billing
-    default_shipping
-    extension_attributes {
-      ...CustomerAddressAttributeFragment
-    }
-    fax
-    firstname
-    id
-    lastname
-    middlename
-    postcode
-    prefix
-    region {
-      ...CustomerAddressRegionFragment
-    }
-    region_id
-    street
-    suffix
-    telephone
-    vat_id
-  }
-}
-
- -
-
-
Variables
- - - 
{"id": 987, "input": CustomerAddressInput}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "updateCustomerAddress": {
-      "city": "abc123",
-      "company": "xyz789",
-      "country_code": "AF",
-      "country_id": "abc123",
-      "custom_attributes": [CustomerAddressAttribute],
-      "customer_id": 123,
-      "default_billing": false,
-      "default_shipping": false,
-      "extension_attributes": [CustomerAddressAttribute],
-      "fax": "abc123",
-      "firstname": "abc123",
-      "id": 987,
-      "lastname": "xyz789",
-      "middlename": "xyz789",
-      "postcode": "abc123",
-      "prefix": "xyz789",
-      "region": CustomerAddressRegion,
-      "region_id": 123,
-      "street": ["abc123"],
-      "suffix": "abc123",
-      "telephone": "xyz789",
-      "vat_id": "xyz789"
-    }
-  }
-}
-
- -
-
-
-
-
-
- Mutations -
-

updateCustomerEmail

-
-
-
-
Description
-

Change the email address for the logged-in customer.

-
-
-
-
-
-
-
Response
-

Returns a - CustomerOutput -

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

Example

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

updateCustomerV2

-
-
-
-
Description
-

Update the customer's personal information.

-
-
-
-
-
-
-
Response
-

Returns a - CustomerOutput -

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

Example

-
-
Query
- - - 
mutation updateCustomerV2($input: CustomerUpdateInput!) {
-  updateCustomerV2(input: $input) {
-    customer {
-      ...CustomerFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": CustomerUpdateInput}
-
- -
-
-
Response
- - - 
{"data": {"updateCustomerV2": {"customer": Customer}}}
-
- -
-
-
-
-
-
- Mutations -
-

updateGiftRegistry

-
-
-
-
Description
-

Update the specified gift registry.

-
-
-
-
-
-
-
Response
-

Returns an - 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
- - - 
mutation updateGiftRegistry(
-  $giftRegistryUid: ID!,
-  $giftRegistry: UpdateGiftRegistryInput!
-) {
-  updateGiftRegistry(
-    giftRegistryUid: $giftRegistryUid,
-    giftRegistry: $giftRegistry
-  ) {
-    gift_registry {
-      ...GiftRegistryFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{
-  "giftRegistryUid": "4",
-  "giftRegistry": UpdateGiftRegistryInput
-}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "updateGiftRegistry": {"gift_registry": GiftRegistry}
-  }
-}
-
- -
-
-
-
-
-
- Mutations -
-

updateGiftRegistryItems

-
-
-
-
Description
-

Update the specified items in the gift registry.

-
-
-
-
-
-
-
Response
-

Returns an - UpdateGiftRegistryItemsOutput -

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

Example

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

updateGiftRegistryRegistrants

-
-
-
-
Description
-

Modify the properties of one or more gift registry registrants.

-
-
-
-
-
-
-
Response
-

Returns an - UpdateGiftRegistryRegistrantsOutput -

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

Example

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

updateNegotiableQuoteQuantities

-
-
-
-
Description
-

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

-
-
-
-
-
-
-
Response
-

Returns an - UpdateNegotiableQuoteItemsQuantityOutput -

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

Example

-
-
Query
- - - 
mutation updateNegotiableQuoteQuantities($input: UpdateNegotiableQuoteQuantitiesInput!) {
-  updateNegotiableQuoteQuantities(input: $input) {
-    quote {
-      ...NegotiableQuoteFragment
-    }
-  }
-}
-
- -
-
-
Variables
- - - 
{"input": UpdateNegotiableQuoteQuantitiesInput}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "updateNegotiableQuoteQuantities": {
-      "quote": NegotiableQuote
-    }
-  }
-}
-
- -
-
-
-
-
-
- Mutations -
-

updateProductsInWishlist

-
-
-
-
Description
-

Update one or more products in the specified wish list.

-
-
-
-
-
-
-
Response
-

Returns an - UpdateProductsInWishlistOutput -

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

Example

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

updatePurchaseOrderApprovalRule

-
-
-
-
Description
-

Update existing purchase order approval rules.

-
-
-
-
-
-
-
Response
-

Returns a - PurchaseOrderApprovalRule -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- input - - - UpdatePurchaseOrderApprovalRuleInput! - -
-
-
-
-

Example

-
-
Query
- - - 
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
- - - 
{"input": UpdatePurchaseOrderApprovalRuleInput}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "updatePurchaseOrderApprovalRule": {
-      "applies_to_roles": [CompanyRole],
-      "approver_roles": [CompanyRole],
-      "condition": PurchaseOrderApprovalRuleConditionInterface,
-      "created_at": "xyz789",
-      "created_by": "xyz789",
-      "description": "xyz789",
-      "name": "abc123",
-      "status": "ENABLED",
-      "uid": "4",
-      "updated_at": "xyz789"
-    }
-  }
-}
-
- -
-
-
-
-
-
- Mutations -
-

updateRequisitionList

-
-
-
-
Description
-

Rename a requisition list and change its description.

-
-
-
-
-
-
-
Response
-

Returns an - UpdateRequisitionListOutput -

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

Example

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

updateRequisitionListItems

-
-
-
-
Description
-

Update items in a requisition list.

-
-
-
-
-
-
-
Response
-

Returns an - UpdateRequisitionListItemsOutput -

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

Example

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

updateWishlist

-
-
-
-
Description
-

Change the name and visibility of the specified wish list.

-
-
-
-
-
-
-
Response
-

Returns an - 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
- - - 
mutation updateWishlist(
-  $wishlistId: ID!,
-  $name: String,
-  $visibility: WishlistVisibilityEnum
-) {
-  updateWishlist(
-    wishlistId: $wishlistId,
-    name: $name,
-    visibility: $visibility
-  ) {
-    name
-    uid
-    visibility
-  }
-}
-
- -
-
-
Variables
- - - 
{
-  "wishlistId": 4,
-  "name": "abc123",
-  "visibility": "PUBLIC"
-}
-
- -
-
-
Response
- - - 
{
-  "data": {
-    "updateWishlist": {
-      "name": "xyz789",
-      "uid": "4",
-      "visibility": "PUBLIC"
-    }
-  }
-}
-
- -
-
-
-
-
-
- Mutations -
-

validatePurchaseOrders

-
-
-
-
Description
-

Validate purchase orders.

-
-
-
-
-
-
-
Response
-

Returns a - ValidatePurchaseOrdersOutput -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- input - - - ValidatePurchaseOrdersInput! - -
-
-
-
-

Example

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

Types

-
-

AddBundleProductsToCartInput

-
-
-
-
Description
-

Defines the bundle products to add to the cart.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Input FieldDescription
- cart_id - - - String! - - -

The ID of the cart.

-
- cart_items - - - [BundleProductCartItemInput]! - - -

An array of bundle products to add.

-
-
-
-
-
-
Example
- - - 
{
-  "cart_id": "xyz789",
-  "cart_items": [BundleProductCartItemInput]
-}
-
- -
-
-
-
-
-
- Types -
-

AddBundleProductsToCartOutput

-
-
-
-
Description
-

Contains details about the cart after adding bundle products.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- cart - - - Cart! - - The cart after adding products.
-
-
-
-
-
Example
- - - 
{"cart": Cart}
-
- -
-
-
-
-
-
- Types -
-

AddConfigurableProductsToCartInput

-
-
-
-
Description
-

Defines the configurable products to add to the cart.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Input FieldDescription
- cart_id - - - String! - - -

The ID of the cart.

-
- cart_items - - - [ConfigurableProductCartItemInput]! - - -

An array of configurable products to add.

-
-
-
-
-
-
Example
- - - 
{
-  "cart_id": "abc123",
-  "cart_items": [ConfigurableProductCartItemInput]
-}
-
- -
-
-
-
-
-
- Types -
-

AddConfigurableProductsToCartOutput

-
-
-
-
Description
-

Contains details about the cart after adding configurable products.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- cart - - - Cart! - - The cart after adding products.
-
-
-
-
-
Example
- - - 
{"cart": Cart}
-
- -
-
-
-
-
-
- Types -
-

AddDownloadableProductsToCartInput

-
-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Input FieldDescription
- cart_id - - - String! - - -

The ID of the cart.

-
- cart_items - - - [DownloadableProductCartItemInput]! - - -

An array of downloadable products to add.

-
-
-
-
-
-
Example
- - - 
{
-  "cart_id": "abc123",
-  "cart_items": [DownloadableProductCartItemInput]
-}
-
- -
-
-
-
-
-
- Types -
-

AddDownloadableProductsToCartOutput

-
-
-
-
Description
-

Contains details about the cart after adding downloadable products.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- cart - - - Cart! - - The cart after adding products.
-
-
-
-
-
Example
- - - 
{"cart": Cart}
-
- -
-
-
-
-
-
- Types -
-

AddGiftRegistryRegistrantInput

-
-
-
-
Description
-

Defines a new registrant.

-
-
-
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
- - - 
{
-  "dynamic_attributes": [
-    GiftRegistryDynamicAttributeInput
-  ],
-  "email": "abc123",
-  "firstname": "xyz789",
-  "lastname": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

AddGiftRegistryRegistrantsOutput

-
-
-
-
Description
-

Contains the results of a request to add registrants.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- gift_registry - - - GiftRegistry - - The gift registry after adding registrants.
-
-
-
-
-
Example
- - - 
{"gift_registry": GiftRegistry}
-
- -
-
-
-
-
-
- Types -
-

AddProductsToCartOutput

-
-
-
-
Description
-

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
- - - 
{
-  "cart": Cart,
-  "user_errors": [CartUserInputError]
-}
-
- -
-
-
-
-
-
- Types -
-

AddProductsToCompareListInput

-
-
-
-
Description
-

Contains products to add to an existing compare list.

-
-
-
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
- - - 
{"products": ["4"], "uid": 4}
-
- -
-
-
-
-
-
- Types -
-

AddProductsToRequisitionListOutput

-
-
-
-
Description
-

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

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- requisition_list - - - RequisitionList - - The requisition list after adding products.
-
-
-
-
-
Example
- - - 
{"requisition_list": RequisitionList}
-
- -
-
-
-
-
-
- Types -
-

AddProductsToWishlistOutput

-
-
-
-
Description
-

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
- - - 
{
-  "user_errors": [WishListUserInputError],
-  "wishlist": Wishlist
-}
-
- -
-
-
-
-
-
- Types -
-

AddPurchaseOrderCommentInput

-
-
-
-
Description
-

Contains the comment to be added to a purchase order.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Input FieldDescription
- comment - - - String! - - -

Comment text.

-
- purchase_order_uid - - - ID! - - -

The unique ID of a purchase order.

-
-
-
-
-
-
Example
- - - 
{
-  "comment": "xyz789",
-  "purchase_order_uid": "4"
-}
-
- -
-
-
-
-
-
- Types -
-

AddPurchaseOrderCommentOutput

-
-
-
-
Description
-

Contains the successfully added comment.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- comment - - - PurchaseOrderComment! - - The purchase order comment.
-
-
-
-
-
Example
- - - 
{"comment": PurchaseOrderComment}
-
- -
-
-
-
-
-
- Types -
-

AddPurchaseOrderItemsToCartInput

-
-
-
-
Description
-

Defines the purchase order and cart to act on.

-
-
-
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
- - - 
{
-  "cart_id": "abc123",
-  "purchase_order_uid": "4",
-  "replace_existing_cart_items": true
-}
-
- -
-
-
-
-
-
- Types -
-

AddRequisitionListItemToCartUserError

-
-
-
-
Description
-

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
- - - 
{
-  "message": "abc123",
-  "type": "OUT_OF_STOCK"
-}
-
- -
-
-
-
-
-
- Types -
-

AddRequisitionListItemToCartUserErrorType

-
-
-
-
Values
- - - - - - - - - - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

OUT_OF_STOCK

-
-

UNAVAILABLE_SKU

-
-

OPTIONS_UPDATED

-
-

LOW_QUANTITY

-
-
-
-
-
-
Example
- - - 
"OUT_OF_STOCK"
-
- -
-
-
-
-
-
- Types -
-

AddRequisitionListItemsToCartOutput

-
-
-
-
Description
-

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
- - - 
{
-  "add_requisition_list_items_to_cart_user_errors": [
-    AddRequisitionListItemToCartUserError
-  ],
-  "cart": Cart,
-  "status": false
-}
-
- -
-
-
-
-
-
- Types -
-

AddReturnCommentInput

-
-
-
-
Description
-

Defines a return comment.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Input FieldDescription
- comment_text - - - String! - - -

The text added to the return request.

-
- return_uid - - - ID! - - -

The unique ID for a Return object.

-
-
-
-
-
-
Example
- - - 
{
-  "comment_text": "xyz789",
-  "return_uid": "4"
-}
-
- -
-
-
-
-
-
- Types -
-

AddReturnCommentOutput

-
-
-
-
Description
-

Contains details about the return request.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- return - - - Return - - The modified return.
-
-
-
-
-
Example
- - - 
{"return": Return}
-
- -
-
-
-
-
-
- Types -
-

AddReturnTrackingInput

-
-
-
-
Description
-

Defines tracking information to be added to the return.

-
-
-
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
- - - 
{
-  "carrier_uid": 4,
-  "return_uid": 4,
-  "tracking_number": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

AddReturnTrackingOutput

-
-
-
-
Description
-

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
- - - 
{
-  "return": Return,
-  "return_shipping_tracking": ReturnShippingTracking
-}
-
- -
-
-
-
-
-
- Types -
-

AddSimpleProductsToCartInput

-
-
-
-
Description
-

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

-
-
-
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
- - - 
{
-  "cart_id": "xyz789",
-  "cart_items": [SimpleProductCartItemInput]
-}
-
- -
-
-
-
-
-
- Types -
-

AddSimpleProductsToCartOutput

-
-
-
-
Description
-

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

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- cart - - - Cart! - - The cart after adding products.
-
-
-
-
-
Example
- - - 
{"cart": Cart}
-
- -
-
-
-
-
-
- Types -
-

AddVirtualProductsToCartInput

-
-
-
-
Description
-

Defines the virtual products to add to the cart.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Input FieldDescription
- cart_id - - - String! - - -

The unique ID of a Cart object.

-
- cart_items - - - [VirtualProductCartItemInput]! - - -

An array of virtual products to add.

-
-
-
-
-
-
Example
- - - 
{
-  "cart_id": "abc123",
-  "cart_items": [VirtualProductCartItemInput]
-}
-
- -
-
-
-
-
-
- Types -
-

AddVirtualProductsToCartOutput

-
-
-
-
Description
-

Contains details about the cart after adding virtual products.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- cart - - - Cart! - - The cart after adding products.
-
-
-
-
-
Example
- - - 
{"cart": Cart}
-
- -
-
-
-
-
-
- Types -
-

AddWishlistItemsToCartOutput

-
-
-
-
Description
-

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
- - - 
{
-  "add_wishlist_items_to_cart_user_errors": [
-    WishlistCartUserInputError
-  ],
-  "status": false,
-  "wishlist": Wishlist
-}
-
- -
-
-
-
-
-
- Types -
-

Aggregation

-
-
-
-
Description
-

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
- - - 
{
-  "attribute_code": "abc123",
-  "count": 123,
-  "label": "xyz789",
-  "options": [AggregationOption],
-  "position": 123
-}
-
- -
-
-
-
-
-
- Types -
-

AggregationOption

-
-
-
-
Description
-

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
- - - 
{
-  "count": 123,
-  "label": "xyz789",
-  "value": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

AggregationOptionInterface

-
-
-
-
Description
-

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
- - - 
{
-  "count": 987,
-  "label": "abc123",
-  "value": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

AggregationsCategoryFilterInput

-
-
-
-
Description
-

Filter category aggregations in layered navigation.

-
-
-
Fields
- - - - - - - - - - - - - -
Input FieldDescription
- includeDirectChildrenOnly - - - Boolean - - -

Indicates whether to include only direct subcategories or all children categories at all levels.

-
-
-
-
-
-
Example
- - - 
{"includeDirectChildrenOnly": false}
-
- -
-
-
-
-
-
- Types -
-

AggregationsFilterInput

-
-
-
-
Description
-

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

-
-
-
Fields
- - - - - - - - - - - - - -
Input FieldDescription
- category - - - AggregationsCategoryFilterInput - - -

Filter category aggregations in layered navigation.

-
-
-
-
-
-
Example
- - - 
{"category": AggregationsCategoryFilterInput}
-
- -
-
-
-
-
-
- Types -
-

AppliedCoupon

-
-
-
-
Description
-

Contains the applied coupon code.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- code - - - String! - - The coupon code the shopper applied to the card.
-
-
-
-
-
Example
- - - 
{"code": "abc123"}
-
- -
-
-
-
-
-
- Types -
-

AppliedGiftCard

-
-
-
-
Description
-

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
- - - 
{
-  "applied_balance": Money,
-  "code": "xyz789",
-  "current_balance": Money,
-  "expiration_date": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

AppliedStoreCredit

-
-
-
-
Description
-

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
- - - 
{
-  "applied_balance": Money,
-  "current_balance": Money,
-  "enabled": true
-}
-
- -
-
-
-
-
-
- Types -
-

ApplyCouponToCartInput

-
-
-
-
Description
-

Specifies the coupon code to apply to the cart.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Input FieldDescription
- cart_id - - - String! - - -

The unique ID of a Cart object.

-
- coupon_code - - - String! - - -

A valid coupon code.

-
-
-
-
-
-
Example
- - - 
{
-  "cart_id": "xyz789",
-  "coupon_code": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

ApplyCouponToCartOutput

-
-
-
-
Description
-

Contains details about the cart after applying a coupon.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- cart - - - Cart! - - The cart after applying a coupon.
-
-
-
-
-
Example
- - - 
{"cart": Cart}
-
- -
-
-
-
-
-
- Types -
-

ApplyGiftCardToCartInput

-
-
-
-
Description
-

Defines the input required to run the applyGiftCardToCart mutation.

-
-
-
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
- - - 
{
-  "cart_id": "abc123",
-  "gift_card_code": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

ApplyGiftCardToCartOutput

-
-
-
-
Description
-

Defines the possible output for the applyGiftCardToCart mutation.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- cart - - - Cart! - - Describes the contents of the specified shopping cart.
-
-
-
-
-
Example
- - - 
{"cart": Cart}
-
- -
-
-
-
-
-
- Types -
-

ApplyRewardPointsToCartOutput

-
-
-
-
Description
-

Contains the customer cart.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- cart - - - Cart! - - The customer cart after reward points are applied.
-
-
-
-
-
Example
- - - 
{"cart": Cart}
-
- -
-
-
-
-
-
- Types -
-

ApplyStoreCreditToCartInput

-
-
-
-
Description
-

Defines the input required to run the applyStoreCreditToCart mutation.

-
-
-
Fields
- - - - - - - - - - - - - -
Input FieldDescription
- cart_id - - - String! - - -

The unique ID that identifies the customer's cart.

-
-
-
-
-
-
Example
- - - 
{"cart_id": "xyz789"}
-
- -
-
-
-
-
-
- Types -
-

ApplyStoreCreditToCartOutput

-
-
-
-
Description
-

Defines the possible output for the applyStoreCreditToCart mutation.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- cart - - - Cart! - - The contents of the specified shopping cart.
-
-
-
-
-
Example
- - - 
{"cart": Cart}
-
- -
-
-
-
-
-
- Types -
-

AreaInput

-
-
-
-
Description
-

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

-
-
-
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
- - - 
{"radius": 987, "search_term": "xyz789"}
-
- -
-
-
-
-
-
- Types -
-

AssignCompareListToCustomerOutput

-
-
-
-
Description
-

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
- - - 
{"compare_list": CompareList, "result": false}
-
- -
-
-
-
-
-
- Types -
-

Attribute

-
-
-
-
Description
-

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
- - - 
{
-  "attribute_code": "xyz789",
-  "attribute_options": [AttributeOption],
-  "attribute_type": "xyz789",
-  "entity_type": "abc123",
-  "input_type": "xyz789",
-  "storefront_properties": StorefrontProperties
-}
-
- -
-
-
-
-
-
- Types -
-

AttributeInput

-
-
-
-
Description
-

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

-
-
-
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
- - - 
{
-  "attribute_code": "xyz789",
-  "entity_type": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

AttributeOption

-
-
-
-
Description
-

Defines an attribute option.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- label - - - String - - The label assigned to the attribute option.
- value - - - String - - The attribute option value.
-
-
-
-
-
Example
- - - 
{
-  "label": "xyz789",
-  "value": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

AvailableCurrency

-
-
-
-
Description
-

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
- - - 
{"code": "AFN", "symbol": "abc123"}
-
- -
-
-
-
-
-
- Types -
-

AvailablePaymentMethod

-
-
-
-
Description
-

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
- - - 
{
-  "code": "xyz789",
-  "is_deferred": true,
-  "title": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

AvailableShippingMethod

-
-
-
-
Description
-

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 - - - 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
- - - 
{
-  "amount": Money,
-  "available": false,
-  "base_amount": Money,
-  "carrier_code": "xyz789",
-  "carrier_title": "xyz789",
-  "error_message": "xyz789",
-  "method_code": "xyz789",
-  "method_title": "xyz789",
-  "price_excl_tax": Money,
-  "price_incl_tax": Money
-}
-
- -
-
-
-
-
-
- Types -
-

BatchMutationStatus

-
-
-
-
Values
- - - - - - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

SUCCESS

-
-

FAILURE

-
-

MIXED_RESULTS

-
-
-
-
-
-
Example
- - - 
"SUCCESS"
-
- -
-
-
-
-
-
- Types -
-

BillingAddressInput

-
-
-
-
Description
-

Defines the billing address.

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

-
- 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
- - - 
{
-  "address": CartAddressInput,
-  "customer_address_id": 123,
-  "same_as_shipping": false,
-  "use_for_shipping": true
-}
-
- -
-
-
-
-
-
- Types -
-

BillingCartAddress

-
-
-
-
Description
-

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.
- customer_notes - - - String - - - The field is used only in shipping address. -
- firstname - - - String! - - The first name of the customer or guest.
- lastname - - - String! - - The last name of the customer or guest.
- postcode - - - String - - The ZIP or postal code of the billing or shipping address.
- region - - - CartAddressRegion - - An object containing the region label and code.
- street - - - [String]! - - An array containing the street for the billing or shipping address.
- telephone - - - String - - The telephone number for the billing or shipping address.
- uid - - - String! - - The unique id of the customer address.
- vat_id - - - String - - The VAT company number for billing or shipping address.
-
-
-
-
-
Example
- - - 
{
-  "city": "xyz789",
-  "company": "xyz789",
-  "country": CartAddressCountry,
-  "customer_notes": "abc123",
-  "firstname": "xyz789",
-  "lastname": "abc123",
-  "postcode": "abc123",
-  "region": CartAddressRegion,
-  "street": ["abc123"],
-  "telephone": "abc123",
-  "uid": "xyz789",
-  "vat_id": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

Boolean

-
-
-
-
Description
-

The Boolean scalar type represents true or false.

-
-
-
-
-
-
-
- Types -
-

BraintreeCcVaultInput

-
-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Input FieldDescription
- device_data - - - String - -
- public_hash - - - String! - -
-
-
-
-
-
Example
- - - 
{
-  "device_data": "xyz789",
-  "public_hash": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

BraintreeInput

-
-
-
-
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 an entered by a customer credit/debit card should be tokenized for later usage. Required only if Vault is enabled for Braintree payment integration.

-
- payment_method_nonce - - - String! - - -

The one-time payment token generated by Braintree payment gateway based on card details. Required field to make sale transaction.

-
-
-
-
-
-
Example
- - - 
{
-  "device_data": "abc123",
-  "is_active_payment_token_enabler": false,
-  "payment_method_nonce": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

Breadcrumb

-
-
-
-
Description
-

Contains details about an individual category that comprises a breadcrumb.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- category_id - - - Int - - The ID of the category. - 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
- - - 
{
-  "category_id": 123,
-  "category_level": 123,
-  "category_name": "xyz789",
-  "category_uid": "4",
-  "category_url_key": "abc123",
-  "category_url_path": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

BundleCartItem

-
-
-
-
Description
-

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.
- 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! - - - Use uid instead. -
- 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
- - - 
{
-  "available_gift_wrapping": [GiftWrapping],
-  "bundle_options": [SelectedBundleOption],
-  "customizable_options": [SelectedCustomizableOption],
-  "errors": [CartItemError],
-  "gift_message": GiftMessage,
-  "gift_wrapping": GiftWrapping,
-  "id": "abc123",
-  "prices": CartItemPrices,
-  "product": ProductInterface,
-  "quantity": 987.65,
-  "uid": 4
-}
-
- -
-
-
-
-
-
- Types -
-

BundleCreditMemoItem

-
-
-
-
Description
-

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
- - - 
{
-  "bundle_options": [ItemSelectedBundleOption],
-  "discounts": [Discount],
-  "id": "4",
-  "order_item": OrderItemInterface,
-  "product_name": "xyz789",
-  "product_sale_price": Money,
-  "product_sku": "xyz789",
-  "quantity_refunded": 987.65
-}
-
- -
-
-
-
-
-
- Types -
-

BundleInvoiceItem

-
-
-
-
Description
-

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
- - - 
{
-  "bundle_options": [ItemSelectedBundleOption],
-  "discounts": [Discount],
-  "id": "4",
-  "order_item": OrderItemInterface,
-  "product_name": "abc123",
-  "product_sale_price": Money,
-  "product_sku": "xyz789",
-  "quantity_invoiced": 123.45
-}
-
- -
-
-
-
-
-
- Types -
-

BundleItem

-
-
-
-
Description
-

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. - 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
- - - 
{
-  "option_id": 123,
-  "options": [BundleItemOption],
-  "position": 123,
-  "price_range": PriceRange,
-  "required": false,
-  "sku": "abc123",
-  "title": "abc123",
-  "type": "abc123",
-  "uid": 4
-}
-
- -
-
-
-
-
-
- Types -
-

BundleItemOption

-
-
-
-
Description
-

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. - 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. - Use quantity instead. -
- quantity - - - Float - - The quantity of this specific bundle item.
- uid - - - ID! - - The unique ID for a BundleItemOption object.
-
-
-
-
-
Example
- - - 
{
-  "can_change_quantity": false,
-  "id": 123,
-  "is_default": false,
-  "label": "abc123",
-  "position": 123,
-  "price": 987.65,
-  "price_type": "FIXED",
-  "product": ProductInterface,
-  "qty": 123.45,
-  "quantity": 987.65,
-  "uid": "4"
-}
-
- -
-
-
-
-
-
- Types -
-

BundleOptionInput

-
-
-
-
Description
-

Defines the input for a bundle option.

-
-
-
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
- - - 
{
-  "id": 123,
-  "quantity": 123.45,
-  "value": ["abc123"]
-}
-
- -
-
-
-
-
-
- Types -
-

BundleOrderItem

-
-
-
-
Description
-

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.
- 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_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
- - - 
{
-  "bundle_options": [ItemSelectedBundleOption],
-  "discounts": [Discount],
-  "eligible_for_return": false,
-  "entered_options": [OrderItemOption],
-  "gift_message": GiftMessage,
-  "gift_wrapping": GiftWrapping,
-  "id": 4,
-  "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": 123.45,
-  "quantity_refunded": 123.45,
-  "quantity_returned": 123.45,
-  "quantity_shipped": 123.45,
-  "selected_options": [OrderItemOption],
-  "status": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

BundleProduct

-
-
-
-
Description
-

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

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- activity - - - String - - - Use the custom_attributes field instead. -
- attribute_set_id - - - Int - - The attribute set assigned to the product. - 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.
- category_gear - - - String - - - Use the custom_attributes field instead. -
- climate - - - String - - - Use the custom_attributes field instead. -
- collar - - - String - - - Use the custom_attributes field instead. -
- color - - - Int - - - 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. - The field should not be used on the storefront. -
- crosssell_products - - - [ProductInterface] - - An array of cross-sell products.
- 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.
- eco_collection - - - Int - - - Use the custom_attributes field instead. -
- erin_recommends - - - Int - - - Use the custom_attributes field instead. -
- features_bags - - - String - - - Use the custom_attributes field instead. -
- format - - - Int - - - Use the custom_attributes field instead. -
- gender - - - String - - - Use the custom_attributes field instead. -
- gift_message_available - - - String - - Indicates whether a gift message is available.
- id - - - Int - - The ID number assigned to the product. - 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. - Use the custom_attributes field instead. -
- material - - - String - - - Use the custom_attributes field instead. -
- media_gallery - - - [MediaGalleryInterface] - - An array of media gallery objects.
- media_gallery_entries - - - [MediaGalleryEntry] - - An array of MediaGalleryEntry objects. - 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.
- name - - - String - - The product name. Customers use this name to identify the product.
- new - - - Int - - - Use the custom_attributes field instead. -
- 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.
- pattern - - - String - - - Use the custom_attributes field instead. -
- performance_fabric - - - Int - - - Use the custom_attributes field instead. -
- price - - - ProductPrices - - Indicates the price of an item. - 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.
- price_view - - - PriceViewEnum - - One of PRICE_RANGE or AS_LOW_AS.
- product_links - - - [ProductLinksInterface] - - An array of ProductLinks objects.
- purpose - - - Int - - - Use the custom_attributes field instead. -
- 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.
-
-
Arguments
-
-
-
- pageSize - - - Int - -
-

The maximum number of results to return at once. The default is 20.

-
-
-
- currentPage - - - Int - -
-

The page of results to return. The default is 1.

-
-
-
-
- sale - - - Int - - - Use the custom_attributes field instead. -
- 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.
- size - - - Int - - - Use the custom_attributes field instead. -
- sku - - - String - - A number or code assigned to a product to identify the product, options, price, and manufacturer.
- sleeve - - - String - - - Use the custom_attributes field instead. -
- 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. - 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
- strap_bags - - - String - - - Use the custom_attributes field instead. -
- style_bags - - - String - - - Use the custom_attributes field instead. -
- style_bottom - - - String - - - Use the custom_attributes field instead. -
- style_general - - - String - - - Use the custom_attributes field instead. -
- 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. - Use price_tiers for product tier price information. -
- tier_prices - - - [ProductTierPrices] - - An array of ProductTierPrices objects. - 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. - Use __typename instead. -
- uid - - - ID! - - The unique ID for a ProductInterface object.
- updated_at - - - String - - Timestamp indicating when the product was updated. - 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 - - - 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. - The field should not be used on the storefront. -
- weight - - - Float - - The weight of the item, in units defined by the store.
-
-
-
-
-
Example
- - - 
{
-  "activity": "xyz789",
-  "attribute_set_id": 123,
-  "canonical_url": "abc123",
-  "categories": [CategoryInterface],
-  "category_gear": "abc123",
-  "climate": "xyz789",
-  "collar": "xyz789",
-  "color": 987,
-  "country_of_manufacture": "xyz789",
-  "created_at": "abc123",
-  "crosssell_products": [ProductInterface],
-  "description": ComplexTextValue,
-  "dynamic_price": false,
-  "dynamic_sku": false,
-  "dynamic_weight": false,
-  "eco_collection": 123,
-  "erin_recommends": 123,
-  "features_bags": "xyz789",
-  "format": 123,
-  "gender": "xyz789",
-  "gift_message_available": "abc123",
-  "id": 987,
-  "image": ProductImage,
-  "is_returnable": "xyz789",
-  "items": [BundleItem],
-  "manufacturer": 987,
-  "material": "xyz789",
-  "media_gallery": [MediaGalleryInterface],
-  "media_gallery_entries": [MediaGalleryEntry],
-  "meta_description": "abc123",
-  "meta_keyword": "abc123",
-  "meta_title": "xyz789",
-  "name": "abc123",
-  "new": 987,
-  "new_from_date": "xyz789",
-  "new_to_date": "abc123",
-  "only_x_left_in_stock": 987.65,
-  "options": [CustomizableOptionInterface],
-  "options_container": "abc123",
-  "pattern": "abc123",
-  "performance_fabric": 987,
-  "price": ProductPrices,
-  "price_range": PriceRange,
-  "price_tiers": [TierPrice],
-  "price_view": "PRICE_RANGE",
-  "product_links": [ProductLinksInterface],
-  "purpose": 123,
-  "rating_summary": 123.45,
-  "redirect_code": 123,
-  "related_products": [ProductInterface],
-  "relative_url": "abc123",
-  "review_count": 123,
-  "reviews": ProductReviews,
-  "sale": 123,
-  "ship_bundle_items": "TOGETHER",
-  "short_description": ComplexTextValue,
-  "size": 987,
-  "sku": "abc123",
-  "sleeve": "xyz789",
-  "small_image": ProductImage,
-  "special_from_date": "xyz789",
-  "special_price": 123.45,
-  "special_to_date": "abc123",
-  "staged": true,
-  "stock_status": "IN_STOCK",
-  "strap_bags": "abc123",
-  "style_bags": "abc123",
-  "style_bottom": "abc123",
-  "style_general": "xyz789",
-  "swatch_image": "abc123",
-  "thumbnail": ProductImage,
-  "tier_price": 987.65,
-  "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": 987.65
-}
-
- -
-
-
-
-
-
- Types -
-

BundleProductCartItemInput

-
-
-
-
Description
-

Defines a single bundle product.

-
-
-
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
- - - 
{
-  "bundle_options": [BundleOptionInput],
-  "customizable_options": [CustomizableOptionInput],
-  "data": CartItemInput
-}
-
- -
-
-
-
-
-
- Types -
-

BundleRequisitionListItem

-
-
-
-
Description
-

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
- - - 
{
-  "bundle_options": [SelectedBundleOption],
-  "customizable_options": [SelectedCustomizableOption],
-  "product": ProductInterface,
-  "quantity": 123.45,
-  "uid": "4"
-}
-
- -
-
-
-
-
-
- Types -
-

BundleShipmentItem

-
-
-
-
Description
-

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
- - - 
{
-  "bundle_options": [ItemSelectedBundleOption],
-  "id": "4",
-  "order_item": OrderItemInterface,
-  "product_name": "xyz789",
-  "product_sale_price": Money,
-  "product_sku": "abc123",
-  "quantity_shipped": 987.65
-}
-
- -
-
-
-
-
-
- Types -
-

BundleWishlistItem

-
-
-
-
Description
-

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
- - - 
{
-  "added_at": "abc123",
-  "bundle_options": [SelectedBundleOption],
-  "customizable_options": [SelectedCustomizableOption],
-  "description": "abc123",
-  "id": "4",
-  "product": ProductInterface,
-  "quantity": 987.65
-}
-
- -
-
-
-
-
-
- Types -
-

Cart

-
-
-
-
Description
-

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

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- applied_coupon - - - AppliedCoupon - - - 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.
- prices - - - CartPrices - - Pricing details for the quote.
- printed_card_included - - - Boolean! - - Indicates whether the shopper requested a printed card for the 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
- - - 
{
-  "applied_coupon": AppliedCoupon,
-  "applied_coupons": [AppliedCoupon],
-  "applied_gift_cards": [AppliedGiftCard],
-  "applied_reward_points": RewardPointsAmount,
-  "applied_store_credit": AppliedStoreCredit,
-  "available_gift_wrappings": [GiftWrapping],
-  "available_payment_methods": [AvailablePaymentMethod],
-  "billing_address": BillingCartAddress,
-  "email": "xyz789",
-  "gift_message": GiftMessage,
-  "gift_receipt_included": true,
-  "gift_wrapping": GiftWrapping,
-  "id": 4,
-  "is_virtual": false,
-  "items": [CartItemInterface],
-  "prices": CartPrices,
-  "printed_card_included": true,
-  "selected_payment_method": SelectedPaymentMethod,
-  "shipping_addresses": [ShippingCartAddress],
-  "total_quantity": 987.65
-}
-
- -
-
-
-
-
-
- Types -
-

CartAddressCountry

-
-
-
-
Description
-

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
- - - 
{
-  "code": "xyz789",
-  "label": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

CartAddressInput

-
-
-
-
Description
-

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

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

-
- firstname - - - String! - - -

The first name of the customer or guest.

-
- lastname - - - String! - - -

The last name of the customer or guest.

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

-
- vat_id - - - String - - -

The VAT company number for billing or shipping address.

-
-
-
-
-
-
Example
- - - 
{
-  "city": "abc123",
-  "company": "abc123",
-  "country_code": "xyz789",
-  "firstname": "abc123",
-  "lastname": "xyz789",
-  "postcode": "abc123",
-  "region": "abc123",
-  "region_id": 987,
-  "save_in_address_book": false,
-  "street": ["abc123"],
-  "telephone": "xyz789",
-  "vat_id": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

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.
- firstname - - - String! - - The first name of the customer or guest.
- lastname - - - String! - - The last name of the customer or guest.
- postcode - - - String - - The ZIP or postal code of the billing or shipping address.
- region - - - CartAddressRegion - - An object containing the region label and code.
- street - - - [String]! - - An array containing the street for the billing or shipping address.
- telephone - - - String - - The telephone number for the billing or shipping address.
- uid - - - String! - - The unique id of the customer address.
- vat_id - - - String - - The VAT company number for billing or shipping address.
-
-
-
Possible Types
- - - - - - - - - - - - - - -
CartAddressInterface Types
-

- ShippingCartAddress -

-
-

- BillingCartAddress -

-
-
-
-
-
-
Example
- - - 
{
-  "city": "abc123",
-  "company": "abc123",
-  "country": CartAddressCountry,
-  "firstname": "xyz789",
-  "lastname": "abc123",
-  "postcode": "abc123",
-  "region": CartAddressRegion,
-  "street": ["abc123"],
-  "telephone": "xyz789",
-  "uid": "abc123",
-  "vat_id": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

CartAddressRegion

-
-
-
-
Description
-

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
- - - 
{
-  "code": "xyz789",
-  "label": "xyz789",
-  "region_id": 123
-}
-
- -
-
-
-
-
-
- Types -
-

CartDiscount

-
-
-
-
Description
-

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
- - - 
{
-  "amount": Money,
-  "label": ["xyz789"]
-}
-
- -
-
-
-
-
-
- Types -
-

CartItemError

-
-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- code - - - CartItemErrorType! - - An error code that describes the error encountered
- message - - - String! - - A localized error message
-
-
-
-
-
Example
- - - 
{"code": "UNDEFINED", "message": "abc123"}
-
- -
-
-
-
-
-
- Types -
-

CartItemErrorType

-
-
-
-
Values
- - - - - - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

UNDEFINED

-
-

ITEM_QTY

-
-

ITEM_INCREMENTS

-
-
-
-
-
-
Example
- - - 
"UNDEFINED"
-
- -
-
-
-
-
-
- Types -
-

CartItemInput

-
-
-
-
Description
-

Defines an item to be added to the cart.

-
-
-
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
- - - 
{
-  "entered_options": [EnteredOptionInput],
-  "parent_sku": "xyz789",
-  "quantity": 987.65,
-  "selected_options": ["4"],
-  "sku": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

CartItemInterface

-
-
-
-
Description
-

An interface for products in a cart.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- errors - - - [CartItemError] - - An array of errors encountered while loading the cart item
- id - - - String! - - - Use uid instead. -
- 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 -

-
-

- DownloadableCartItem -

-
-

- BundleCartItem -

-
-

- GiftCardCartItem -

-
-

- ConfigurableCartItem -

-
-
-
-
-
-
Example
- - - 
{
-  "errors": [CartItemError],
-  "id": "xyz789",
-  "prices": CartItemPrices,
-  "product": ProductInterface,
-  "quantity": 123.45,
-  "uid": 4
-}
-
- -
-
-
-
-
-
- Types -
-

CartItemPrices

-
-
-
-
Description
-

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

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- 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.
- 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
- - - 
{
-  "discounts": [Discount],
-  "fixed_product_taxes": [FixedProductTax],
-  "price": Money,
-  "price_including_tax": Money,
-  "row_total": Money,
-  "row_total_including_tax": Money,
-  "total_item_discount": Money
-}
-
- -
-
-
-
-
-
- Types -
-

CartItemQuantity

-
-
-
-
Description
-

Deprecated: The ShippingCartAddress.cart_items field now returns CartItemInterface.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- cart_item_id - - - Int! - - - The ShippingCartAddress.cart_items field now returns CartItemInterface. -
- quantity - - - Float! - - - The ShippingCartAddress.cart_items field now returns CartItemInterface. -
-
-
-
-
-
Example
- - - 
{"cart_item_id": 987, "quantity": 987.65}
-
- -
-
-
-
-
-
- Types -
-

CartItemSelectedOptionValuePrice

-
-
-
-
Description
-

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
- - - 
{
-  "type": "FIXED",
-  "units": "xyz789",
-  "value": 987.65
-}
-
- -
-
-
-
-
-
- Types -
-

CartItemUpdateInput

-
-
-
-
Description
-

A single item to be updated.

-
-
-
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
- - - 
{
-  "cart_item_id": 987,
-  "cart_item_uid": "4",
-  "customizable_options": [CustomizableOptionInput],
-  "gift_message": GiftMessageInput,
-  "gift_wrapping_id": 4,
-  "quantity": 987.65
-}
-
- -
-
-
-
-
-
- Types -
-

CartPrices

-
-
-
-
Description
-

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 - - - 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.
- 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
- - - 
{
-  "applied_taxes": [CartTaxItem],
-  "discount": CartDiscount,
-  "discounts": [Discount],
-  "gift_options": GiftOptionsPrices,
-  "grand_total": Money,
-  "subtotal_excluding_tax": Money,
-  "subtotal_including_tax": Money,
-  "subtotal_with_discount_excluding_tax": Money
-}
-
- -
-
-
-
-
-
- Types -
-

CartTaxItem

-
-
-
-
Description
-

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
- - - 
{
-  "amount": Money,
-  "label": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

CartUserInputError

-
-
-
-
Description
-

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.
-
-
-
-
-
Example
- - - 
{
-  "code": "PRODUCT_NOT_FOUND",
-  "message": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

CartUserInputErrorType

-
-
-
-
Values
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

PRODUCT_NOT_FOUND

-
-

NOT_SALABLE

-
-

INSUFFICIENT_STOCK

-
-

UNDEFINED

-
-

PERMISSION_DENIED

-
-
-
-
-
-
Example
- - - 
"PRODUCT_NOT_FOUND"
-
- -
-
-
-
-
-
- Types -
-

CategoryFilterInput

-
-
-
-
Description
-

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.

-
-
-
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
- - - 
{
-  "category_uid": FilterEqualTypeInput,
-  "ids": FilterEqualTypeInput,
-  "name": FilterMatchTypeInput,
-  "parent_category_uid": FilterEqualTypeInput,
-  "parent_id": FilterEqualTypeInput,
-  "url_key": FilterEqualTypeInput,
-  "url_path": FilterEqualTypeInput
-}
-
- -
-
-
-
-
-
- Types -
-

CategoryInterface

-
-
-
-
Description
-

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. - 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. - 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.
-
-
Arguments
-
-
-
- pageSize - - - Int - -
-

The maximum number of results to return at once. The default value is 20.

-
-
-
- currentPage - - - Int - -
-

The page of results to return. The default value is 1.

-
-
-
- sort - - - ProductAttributeSortInput - -
-

The attributes to sort on, and whether to return the results in ascending or descending order.

-
-
-
-
- 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. - 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
- - - 
{
-  "automatic_sorting": "abc123",
-  "available_sort_by": ["abc123"],
-  "breadcrumbs": [Breadcrumb],
-  "canonical_url": "xyz789",
-  "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": 987.65,
-  "id": 987,
-  "image": "abc123",
-  "include_in_menu": 987,
-  "is_anchor": 123,
-  "landing_page": 123,
-  "level": 987,
-  "meta_description": "xyz789",
-  "meta_keywords": "xyz789",
-  "meta_title": "abc123",
-  "name": "abc123",
-  "path": "abc123",
-  "path_in_store": "abc123",
-  "position": 123,
-  "product_count": 987,
-  "products": CategoryProducts,
-  "staged": true,
-  "uid": "4",
-  "updated_at": "abc123",
-  "url_key": "abc123",
-  "url_path": "xyz789",
-  "url_suffix": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

CategoryProducts

-
-
-
-
Description
-

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
- - - 
{
-  "items": [ProductInterface],
-  "page_info": SearchResultPageInfo,
-  "total_count": 987
-}
-
- -
-
-
-
-
-
- Types -
-

CategoryResult

-
-
-
-
Description
-

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
- - - 
{
-  "items": [CategoryTree],
-  "page_info": SearchResultPageInfo,
-  "total_count": 123
-}
-
- -
-
-
-
-
-
- Types -
-

CategoryTree

-
-
-
-
Description
-

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. - 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. - 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.
-
-
Arguments
-
-
-
- pageSize - - - Int - -
-

The maximum number of results to return at once. The default value is 20.

-
-
-
- currentPage - - - Int - -
-

The page of results to return. The default value is 1.

-
-
-
- sort - - - ProductAttributeSortInput - -
-

The attributes to sort on, and whether to return the results in ascending or descending order.

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

CheckoutAgreement

-
-
-
-
Description
-

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
- - - 
{
-  "agreement_id": 123,
-  "checkbox_text": "abc123",
-  "content": "xyz789",
-  "content_height": "xyz789",
-  "is_html": true,
-  "mode": "AUTO",
-  "name": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

CheckoutAgreementMode

-
-
-
-
Description
-

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
- - - 
"AUTO"
-
- -
-
-
-
-
-
- Types -
-

CheckoutUserInputError

-
-
-
-
Description
-

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
- - - 
{
-  "code": "REORDER_NOT_AVAILABLE",
-  "message": "abc123",
-  "path": ["xyz789"]
-}
-
- -
-
-
-
-
-
- Types -
-

CheckoutUserInputErrorCodes

-
-
-
-
Values
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

REORDER_NOT_AVAILABLE

-
-

PRODUCT_NOT_FOUND

-
-

NOT_SALABLE

-
-

INSUFFICIENT_STOCK

-
-

UNDEFINED

-
-
-
-
-
-
Example
- - - 
"REORDER_NOT_AVAILABLE"
-
- -
-
-
-
-
-
- Types -
-

ClearCustomerCartOutput

-
-
-
-
Description
-

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
- - - 
{"cart": Cart, "status": false}
-
- -
-
-
-
-
-
- Types -
-

CloseNegotiableQuoteError

-
-
-
-
Types
- - - - - - - - - - - - - - - - - -
Union Types
-

- NegotiableQuoteInvalidStateError -

-
-

- NoSuchEntityUidError -

-
-

- InternalError -

-
-
-
-
-
-
Example
- - - 
NegotiableQuoteInvalidStateError
-
- -
-
-
-
-
-
- Types -
-

CloseNegotiableQuoteOperationFailure

-
-
-
-
Description
-

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
- - - 
{
-  "errors": [NegotiableQuoteInvalidStateError],
-  "quote_uid": 4
-}
-
- -
-
-
-
-
-
- Types -
-

CloseNegotiableQuoteOperationResult

-
-
-
-
Types
- - - - - - - - - - - - - - -
Union Types
-

- NegotiableQuoteUidOperationSuccess -

-
-

- CloseNegotiableQuoteOperationFailure -

-
-
-
-
-
-
Example
- - - 
NegotiableQuoteUidOperationSuccess
-
- -
-
-
-
-
-
- Types -
-

CloseNegotiableQuotesInput

-
-
-
-
Description
-

Defines the negotiable quotes to mark as closed.

-
-
-
Fields
- - - - - - - - - - - - - -
Input FieldDescription
- quote_uids - - - [ID]! - - -

A list of unique IDs from NegotiableQuote objects.

-
-
-
-
-
-
Example
- - - 
{"quote_uids": [4]}
-
- -
-
-
-
-
-
- Types -
-

CloseNegotiableQuotesOutput

-
-
-
-
Description
-

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. - Use operation_results instead. -
- negotiable_quotes - - - NegotiableQuotesOutput - - A list of negotiable quotes that can be viewed by the logged-in customer
-
-
Arguments
-
-
-
- filter - - - NegotiableQuoteFilterInput - -
-

The filter to use to determine which negotiable quotes to close.

-
-
-
- pageSize - - - Int - -
-

The maximum number of results to return at once. The default value is 20.

-
-
-
- currentPage - - - Int - -
-

The page of results to return. The default value is 1.

-
-
-
- sort - - - NegotiableQuoteSortInput - -
-

The field to use for sorting results.

-
-
-
-
- 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
- - - 
{
-  "closed_quotes": [NegotiableQuote],
-  "negotiable_quotes": NegotiableQuotesOutput,
-  "operation_results": [
-    NegotiableQuoteUidOperationSuccess
-  ],
-  "result_status": "SUCCESS"
-}
-
- -
-
-
-
-
-
- Types -
-

CmsBlock

-
-
-
-
Description
-

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
- - - 
{
-  "content": "xyz789",
-  "identifier": "abc123",
-  "title": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

CmsBlocks

-
-
-
-
Description
-

Contains an array CMS block items.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- items - - - [CmsBlock] - - An array of CMS blocks.
-
-
-
-
-
Example
- - - 
{"items": [CmsBlock]}
-
- -
-
-
-
-
-
- Types -
-

CmsPage

-
-
-
-
Description
-

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

ColorSwatchData

-
-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- value - - - String - - The value can be represented as color (HEX code), image link, or text.
-
-
-
-
-
Example
- - - 
{"value": "xyz789"}
-
- -
-
-
-
-
-
- Types -
-

Company

-
-
-
-
Description
-

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.
-
-
Arguments
-
-
-
- filter - - - CompanyCreditHistoryFilterInput - -
-
-
-
- pageSize - - - Int - -
-
-
-
- currentPage - - - Int - -
-
-
-
-
- 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.
-
-
Arguments
-
-
-
- id - - - ID! - -
-
-
-
-
- roles - - - CompanyRoles! - - An object that contains a list of company roles.
-
-
Arguments
-
-
-
- pageSize - - - Int - -
-

The maximum number of results to return at once. The default value is 20.

-
-
-
- currentPage - - - Int - -
-

The page of results to return. The default value is 1

-
-
-
-
- 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.
-
-
Arguments
-
-
-
- rootId - - - ID - -
-

The ID of the node in the company structure that serves as the root for the query.

-
-
-
- depth - - - Int - -
-

The maximum number of levels of the structure to return.

-
-
-
-
- team - - - CompanyTeam - - The company team data filtered by the unique ID for a CompanyTeam object.
-
-
Arguments
-
-
-
- id - - - ID! - -
-
-
-
-
- user - - - Customer - - A company user filtered by the unique ID of a Customer object.
-
-
Arguments
-
-
-
- id - - - ID! - -
-
-
-
-
- users - - - CompanyUsers - - An object that contains a list of company users based on activity status.
-
-
Arguments
-
-
-
- filter - - - CompanyUsersFilterInput - -
-

The type of company users to return.

-
-
-
- pageSize - - - Int - -
-

The maximum number of results to return at once. The default value is 20.

-
-
-
- currentPage - - - Int - -
-

The page of results to return. The default value is 1.

-
-
-
-
- vat_tax_id - - - String - - The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes.
-
-
-
-
-
Example
- - - 
{
-  "acl_resources": [CompanyAclResource],
-  "company_admin": Customer,
-  "credit": CompanyCredit,
-  "credit_history": CompanyCreditHistory,
-  "email": "xyz789",
-  "id": 4,
-  "legal_address": CompanyLegalAddress,
-  "legal_name": "xyz789",
-  "name": "abc123",
-  "payment_methods": ["xyz789"],
-  "reseller_id": "abc123",
-  "role": CompanyRole,
-  "roles": CompanyRoles,
-  "sales_representative": CompanySalesRepresentative,
-  "structure": CompanyStructure,
-  "team": CompanyTeam,
-  "user": Customer,
-  "users": CompanyUsers,
-  "vat_tax_id": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

CompanyAclResource

-
-
-
-
Description
-

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
- - - 
{
-  "children": [CompanyAclResource],
-  "id": 4,
-  "sort_order": 987,
-  "text": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

CompanyAdminInput

-
-
-
-
Description
-

Defines the input schema for creating a company administrator.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Input FieldDescription
- 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.

-
-
-
-
-
-
Example
- - - 
{
-  "email": "xyz789",
-  "firstname": "xyz789",
-  "gender": 987,
-  "job_title": "xyz789",
-  "lastname": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

CompanyCreateInput

-
-
-
-
Description
-

Defines the input schema for creating a new company.

-
-
-
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
- - - 
{
-  "company_admin": CompanyAdminInput,
-  "company_email": "abc123",
-  "company_name": "abc123",
-  "legal_address": CompanyLegalAddressCreateInput,
-  "legal_name": "abc123",
-  "reseller_id": "abc123",
-  "vat_tax_id": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

CompanyCredit

-
-
-
-
Description
-

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
- - - 
{
-  "available_credit": Money,
-  "credit_limit": Money,
-  "outstanding_balance": Money
-}
-
- -
-
-
-
-
-
- Types -
-

CompanyCreditHistory

-
-
-
-
Description
-

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
- - - 
{
-  "items": [CompanyCreditOperation],
-  "page_info": SearchResultPageInfo,
-  "total_count": 987
-}
-
- -
-
-
-
-
-
- Types -
-

CompanyCreditHistoryFilterInput

-
-
-
-
Description
-

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

-
-
-
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
- - - 
{
-  "custom_reference_number": "abc123",
-  "operation_type": "ALLOCATION",
-  "updated_by": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

CompanyCreditOperation

-
-
-
-
Description
-

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
- - - 
{
-  "amount": Money,
-  "balance": CompanyCredit,
-  "custom_reference_number": "abc123",
-  "date": "xyz789",
-  "type": "ALLOCATION",
-  "updated_by": CompanyCreditOperationUser
-}
-
- -
-
-
-
-
-
- Types -
-

CompanyCreditOperationType

-
-
-
-
Values
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

ALLOCATION

-
-

UPDATE

-
-

PURCHASE

-
-

REIMBURSEMENT

-
-

REFUND

-
-

REVERT

-
-
-
-
-
-
Example
- - - 
"ALLOCATION"
-
- -
-
-
-
-
-
- Types -
-

CompanyCreditOperationUser

-
-
-
-
Description
-

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
- - - 
{"name": "xyz789", "type": "CUSTOMER"}
-
- -
-
-
-
-
-
- Types -
-

CompanyCreditOperationUserType

-
-
-
-
Values
- - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

CUSTOMER

-
-

ADMIN

-
-
-
-
-
-
Example
- - - 
"CUSTOMER"
-
- -
-
-
-
-
-
- Types -
-

CompanyLegalAddress

-
-
-
-
Description
-

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
- - - 
{
-  "city": "abc123",
-  "country_code": "AF",
-  "postcode": "abc123",
-  "region": CustomerAddressRegion,
-  "street": ["abc123"],
-  "telephone": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

CompanyLegalAddressCreateInput

-
-
-
-
Description
-

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

-
-
-
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
- - - 
{
-  "city": "xyz789",
-  "country_id": "AF",
-  "postcode": "abc123",
-  "region": CustomerAddressRegionInput,
-  "street": ["abc123"],
-  "telephone": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

CompanyLegalAddressUpdateInput

-
-
-
-
Description
-

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

-
-
-
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
- - - 
{
-  "city": "xyz789",
-  "country_id": "AF",
-  "postcode": "abc123",
-  "region": CustomerAddressRegionInput,
-  "street": ["xyz789"],
-  "telephone": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

CompanyRole

-
-
-
-
Description
-

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
- - - 
{
-  "id": "4",
-  "name": "xyz789",
-  "permissions": [CompanyAclResource],
-  "users_count": 987
-}
-
- -
-
-
-
-
-
- Types -
-

CompanyRoleCreateInput

-
-
-
-
Description
-

Defines the input schema for creating a company role.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Input FieldDescription
- name - - - String! - - -

The name of the role to create.

-
- permissions - - - [String]! - - -

A list of resources the role can access.

-
-
-
-
-
-
Example
- - - 
{
-  "name": "xyz789",
-  "permissions": ["abc123"]
-}
-
- -
-
-
-
-
-
- Types -
-

CompanyRoleUpdateInput

-
-
-
-
Description
-

Defines the input schema for updating a company role.

-
-
-
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
- - - 
{
-  "id": 4,
-  "name": "abc123",
-  "permissions": ["xyz789"]
-}
-
- -
-
-
-
-
-
- Types -
-

CompanyRoles

-
-
-
-
Description
-

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
- - - 
{
-  "items": [CompanyRole],
-  "page_info": SearchResultPageInfo,
-  "total_count": 987
-}
-
- -
-
-
-
-
-
- Types -
-

CompanySalesRepresentative

-
-
-
-
Description
-

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
- - - 
{
-  "email": "xyz789",
-  "firstname": "abc123",
-  "lastname": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

CompanyStructure

-
-
-
-
Description
-

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
- - - 
{"items": [CompanyStructureItem]}
-
- -
-
-
-
-
-
- Types -
-

CompanyStructureEntity

-
-
-
-
Types
- - - - - - - - - - - - - - -
Union Types
-

- CompanyTeam -

-
-

- Customer -

-
-
-
-
-
-
Example
- - - 
CompanyTeam
-
- -
-
-
-
-
-
- Types -
-

CompanyStructureItem

-
-
-
-
Description
-

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
- - - 
{
-  "entity": CompanyTeam,
-  "id": "4",
-  "parent_id": 4
-}
-
- -
-
-
-
-
-
- Types -
-

CompanyStructureUpdateInput

-
-
-
-
Description
-

Defines the input schema for updating the company structure.

-
-
-
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
- - - 
{
-  "parent_tree_id": "4",
-  "tree_id": "4"
-}
-
- -
-
-
-
-
-
- Types -
-

CompanyTeam

-
-
-
-
Description
-

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
- - - 
{
-  "description": "xyz789",
-  "id": "4",
-  "name": "xyz789",
-  "structure_id": 4
-}
-
- -
-
-
-
-
-
- Types -
-

CompanyTeamCreateInput

-
-
-
-
Description
-

Defines the input schema for creating a company team.

-
-
-
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
- - - 
{
-  "description": "xyz789",
-  "name": "xyz789",
-  "target_id": "4"
-}
-
- -
-
-
-
-
-
- Types -
-

CompanyTeamUpdateInput

-
-
-
-
Description
-

Defines the input schema for updating a company team.

-
-
-
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
- - - 
{
-  "description": "xyz789",
-  "id": "4",
-  "name": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

CompanyUpdateInput

-
-
-
-
Description
-

Defines the input schema for updating a company.

-
-
-
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
- - - 
{
-  "company_email": "xyz789",
-  "company_name": "abc123",
-  "legal_address": CompanyLegalAddressUpdateInput,
-  "legal_name": "abc123",
-  "reseller_id": "xyz789",
-  "vat_tax_id": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

CompanyUserCreateInput

-
-
-
-
Description
-

Defines the input schema for creating a company user.

-
-
-
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
- - - 
{
-  "email": "abc123",
-  "firstname": "abc123",
-  "job_title": "abc123",
-  "lastname": "xyz789",
-  "role_id": 4,
-  "status": "ACTIVE",
-  "target_id": 4,
-  "telephone": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

CompanyUserStatusEnum

-
-
-
-
Description
-

Defines the list of company user status values.

-
-
-
Values
- - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

ACTIVE

- 		Only active users.
-

INACTIVE

- 		Only inactive users.
-
-
-
-
-
Example
- - - 
"ACTIVE"
-
- -
-
-
-
-
-
- Types -
-

CompanyUserUpdateInput

-
-
-
-
Description
-

Defines the input schema for updating a company user.

-
-
-
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
- - - 
{
-  "email": "abc123",
-  "firstname": "xyz789",
-  "id": "4",
-  "job_title": "xyz789",
-  "lastname": "abc123",
-  "role_id": "4",
-  "status": "ACTIVE",
-  "telephone": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

CompanyUsers

-
-
-
-
Description
-

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
- - - 
{
-  "items": [Customer],
-  "page_info": SearchResultPageInfo,
-  "total_count": 123
-}
-
- -
-
-
-
-
-
- Types -
-

CompanyUsersFilterInput

-
-
-
-
Description
-

Defines the filter for returning a list of company users.

-
-
-
Fields
- - - - - - - - - - - - - -
Input FieldDescription
- status - - - CompanyUserStatusEnum - - -

The activity status to filter on.

-
-
-
-
-
-
Example
- - - 
{"status": "ACTIVE"}
-
- -
-
-
-
-
-
- Types -
-

ComparableAttribute

-
-
-
-
Description
-

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
- - - 
{
-  "code": "xyz789",
-  "label": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

ComparableItem

-
-
-
-
Description
-

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
- - - 
{
-  "attributes": [ProductAttribute],
-  "product": ProductInterface,
-  "uid": "4"
-}
-
- -
-
-
-
-
-
- Types -
-

CompareList

-
-
-
-
Description
-

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
- - - 
{
-  "attributes": [ComparableAttribute],
-  "item_count": 987,
-  "items": [ComparableItem],
-  "uid": "4"
-}
-
- -
-
-
-
-
-
- Types -
-

ComplexTextValue

-
-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- html - - - String! - - Text that can contain HTML tags.
-
-
-
-
-
Example
- - - 
{"html": "abc123"}
-
- -
-
-
-
-
-
- Types -
-

ConfigurableAttributeOption

-
-
-
-
Description
-

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
- - - 
{
-  "code": "xyz789",
-  "label": "abc123",
-  "uid": "4",
-  "value_index": 987
-}
-
- -
-
-
-
-
-
- Types -
-

ConfigurableCartItem

-
-
-
-
Description
-

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.
- 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! - - - Use uid instead. -
- 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
- - - 
{
-  "available_gift_wrapping": [GiftWrapping],
-  "configurable_options": [SelectedConfigurableOption],
-  "configured_variant": ProductInterface,
-  "customizable_options": [SelectedCustomizableOption],
-  "errors": [CartItemError],
-  "gift_message": GiftMessage,
-  "gift_wrapping": GiftWrapping,
-  "id": "abc123",
-  "prices": CartItemPrices,
-  "product": ProductInterface,
-  "quantity": 987.65,
-  "uid": 4
-}
-
- -
-
-
-
-
-
- Types -
-

ConfigurableOptionAvailableForSelection

-
-
-
-
Description
-

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
- - - 
{
-  "attribute_code": "xyz789",
-  "option_value_uids": [4]
-}
-
- -
-
-
-
-
-
- Types -
-

ConfigurableProduct

-
-
-
-
Description
-

Defines basic features of a configurable product and its simple product variants.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- activity - - - String - - - Use the custom_attributes field instead. -
- attribute_set_id - - - Int - - The attribute set assigned to the product. - 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.
- category_gear - - - String - - - Use the custom_attributes field instead. -
- climate - - - String - - - Use the custom_attributes field instead. -
- collar - - - String - - - Use the custom_attributes field instead. -
- color - - - Int - - - 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.
-
-
Arguments
-
-
-
- configurableOptionValueUids - - - [ID!] - -
-
-
-
-
- country_of_manufacture - - - String - - The product's country of origin.
- created_at - - - String - - Timestamp indicating when the product was created. - The field should not be used on the storefront. -
- crosssell_products - - - [ProductInterface] - - An array of cross-sell products.
- description - - - ComplexTextValue - - Detailed information about the product. The value can include simple HTML tags.
- eco_collection - - - Int - - - Use the custom_attributes field instead. -
- erin_recommends - - - Int - - - Use the custom_attributes field instead. -
- features_bags - - - String - - - Use the custom_attributes field instead. -
- format - - - Int - - - Use the custom_attributes field instead. -
- gender - - - String - - - Use the custom_attributes field instead. -
- gift_message_available - - - String - - Indicates whether a gift message is available.
- id - - - Int - - The ID number assigned to the product. - 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. - Use the custom_attributes field instead. -
- material - - - String - - - Use the custom_attributes field instead. -
- media_gallery - - - [MediaGalleryInterface] - - An array of media gallery objects.
- media_gallery_entries - - - [MediaGalleryEntry] - - An array of MediaGalleryEntry objects. - 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.
- name - - - String - - The product name. Customers use this name to identify the product.
- new - - - Int - - - Use the custom_attributes field instead. -
- 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.
- pattern - - - String - - - Use the custom_attributes field instead. -
- performance_fabric - - - Int - - - Use the custom_attributes field instead. -
- price - - - ProductPrices - - Indicates the price of an item. - 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.
- purpose - - - Int - - - Use the custom_attributes field instead. -
- 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.
-
-
Arguments
-
-
-
- pageSize - - - Int - -
-

The maximum number of results to return at once. The default is 20.

-
-
-
- currentPage - - - Int - -
-

The page of results to return. The default is 1.

-
-
-
-
- sale - - - Int - - - Use the custom_attributes field instead. -
- short_description - - - ComplexTextValue - - A short description of the product. Its use depends on the theme.
- size - - - Int - - - Use the custom_attributes field instead. -
- sku - - - String - - A number or code assigned to a product to identify the product, options, price, and manufacturer.
- sleeve - - - String - - - Use the custom_attributes field instead. -
- 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. - 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
- strap_bags - - - String - - - Use the custom_attributes field instead. -
- style_bags - - - String - - - Use the custom_attributes field instead. -
- style_bottom - - - String - - - Use the custom_attributes field instead. -
- style_general - - - String - - - Use the custom_attributes field instead. -
- 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. - Use price_tiers for product tier price information. -
- tier_prices - - - [ProductTierPrices] - - An array of ProductTierPrices objects. - 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. - Use __typename instead. -
- uid - - - ID! - - The unique ID for a ProductInterface object.
- updated_at - - - String - - Timestamp indicating when the product was updated. - 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 - - - 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. - The field should not be used on the storefront. -
- weight - - - Float - - The weight of the item, in units defined by the store.
-
-
-
-
-
Example
- - - 
{
-  "activity": "abc123",
-  "attribute_set_id": 987,
-  "canonical_url": "abc123",
-  "categories": [CategoryInterface],
-  "category_gear": "abc123",
-  "climate": "abc123",
-  "collar": "xyz789",
-  "color": 987,
-  "configurable_options": [ConfigurableProductOptions],
-  "configurable_product_options_selection": ConfigurableProductOptionsSelection,
-  "country_of_manufacture": "abc123",
-  "created_at": "xyz789",
-  "crosssell_products": [ProductInterface],
-  "description": ComplexTextValue,
-  "eco_collection": 123,
-  "erin_recommends": 123,
-  "features_bags": "abc123",
-  "format": 123,
-  "gender": "xyz789",
-  "gift_message_available": "abc123",
-  "id": 987,
-  "image": ProductImage,
-  "is_returnable": "xyz789",
-  "manufacturer": 987,
-  "material": "abc123",
-  "media_gallery": [MediaGalleryInterface],
-  "media_gallery_entries": [MediaGalleryEntry],
-  "meta_description": "abc123",
-  "meta_keyword": "abc123",
-  "meta_title": "abc123",
-  "name": "abc123",
-  "new": 987,
-  "new_from_date": "xyz789",
-  "new_to_date": "xyz789",
-  "only_x_left_in_stock": 123.45,
-  "options": [CustomizableOptionInterface],
-  "options_container": "abc123",
-  "pattern": "xyz789",
-  "performance_fabric": 987,
-  "price": ProductPrices,
-  "price_range": PriceRange,
-  "price_tiers": [TierPrice],
-  "product_links": [ProductLinksInterface],
-  "purpose": 987,
-  "rating_summary": 123.45,
-  "redirect_code": 123,
-  "related_products": [ProductInterface],
-  "relative_url": "abc123",
-  "review_count": 123,
-  "reviews": ProductReviews,
-  "sale": 987,
-  "short_description": ComplexTextValue,
-  "size": 123,
-  "sku": "xyz789",
-  "sleeve": "xyz789",
-  "small_image": ProductImage,
-  "special_from_date": "xyz789",
-  "special_price": 123.45,
-  "special_to_date": "abc123",
-  "staged": true,
-  "stock_status": "IN_STOCK",
-  "strap_bags": "abc123",
-  "style_bags": "xyz789",
-  "style_bottom": "xyz789",
-  "style_general": "xyz789",
-  "swatch_image": "xyz789",
-  "thumbnail": ProductImage,
-  "tier_price": 123.45,
-  "tier_prices": [ProductTierPrices],
-  "type": "CMS_PAGE",
-  "type_id": "xyz789",
-  "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": 987.65
-}
-
- -
-
-
-
-
-
- Types -
-

ConfigurableProductCartItemInput

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

Deprecated. Use CartItemInput.sku instead.

-
-
-
-
-
-
Example
- - - 
{
-  "customizable_options": [CustomizableOptionInput],
-  "data": CartItemInput,
-  "parent_sku": "xyz789",
-  "variant_sku": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

ConfigurableProductOption

-
-
-
-
Description
-

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
- - - 
{
-  "attribute_code": "xyz789",
-  "label": "abc123",
-  "uid": 4,
-  "values": [ConfigurableProductOptionValue]
-}
-
- -
-
-
-
-
-
- Types -
-

ConfigurableProductOptionValue

-
-
-
-
Description
-

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
- - - 
{
-  "is_available": true,
-  "is_use_default": true,
-  "label": "xyz789",
-  "swatch": SwatchDataInterface,
-  "uid": 4
-}
-
- -
-
-
-
-
-
- Types -
-

ConfigurableProductOptions

-
-
-
-
Description
-

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. - Use attribute_uid instead. -
- attribute_id_v2 - - - Int - - The ID assigned to the attribute. - 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. - 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. - 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
- - - 
{
-  "attribute_code": "abc123",
-  "attribute_id": "xyz789",
-  "attribute_id_v2": 987,
-  "attribute_uid": "4",
-  "id": 123,
-  "label": "abc123",
-  "position": 987,
-  "product_id": 123,
-  "uid": "4",
-  "use_default": true,
-  "values": [ConfigurableProductOptionsValues]
-}
-
- -
-
-
-
-
-
- Types -
-

ConfigurableProductOptionsSelection

-
-
-
-
Description
-

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
- - - 
{
-  "configurable_options": [ConfigurableProductOption],
-  "media_gallery": [MediaGalleryInterface],
-  "options_available_for_selection": [
-    ConfigurableOptionAvailableForSelection
-  ],
-  "variant": SimpleProduct
-}
-
- -
-
-
-
-
-
- Types -
-

ConfigurableProductOptionsValues

-
-
-
-
Description
-

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. - Use uid instead. -
-
-
-
-
-
Example
- - - 
{
-  "default_label": "abc123",
-  "label": "abc123",
-  "store_label": "xyz789",
-  "swatch_data": SwatchDataInterface,
-  "uid": 4,
-  "use_default_value": false,
-  "value_index": 987
-}
-
- -
-
-
-
-
-
- Types -
-

ConfigurableRequisitionListItem

-
-
-
-
Description
-

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
- - - 
{
-  "configurable_options": [SelectedConfigurableOption],
-  "customizable_options": [SelectedCustomizableOption],
-  "product": ProductInterface,
-  "quantity": 987.65,
-  "uid": 4
-}
-
- -
-
-
-
-
-
- Types -
-

ConfigurableVariant

-
-
-
-
Description
-

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
- - - 
{
-  "attributes": [ConfigurableAttributeOption],
-  "product": SimpleProduct
-}
-
- -
-
-
-
-
-
- Types -
-

ConfigurableWishlistItem

-
-
-
-
Description
-

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. - 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
- - - 
{
-  "added_at": "xyz789",
-  "child_sku": "abc123",
-  "configurable_options": [SelectedConfigurableOption],
-  "configured_variant": ProductInterface,
-  "customizable_options": [SelectedCustomizableOption],
-  "description": "xyz789",
-  "id": 4,
-  "product": ProductInterface,
-  "quantity": 987.65
-}
-
- -
-
-
-
-
-
- Types -
-

CopyItemsBetweenRequisitionListsInput

-
-
-
-
Description
-

An input object that defines the items in a requisition list to be copied.

-
-
-
Fields
- - - - - - - - - - - - - -
Input FieldDescription
- requisitionListItemUids - - - [ID]! - - -

An array of IDs representing products copied from one requisition list to another.

-
-
-
-
-
-
Example
- - - 
{"requisitionListItemUids": [4]}
-
- -
-
-
-
-
-
- Types -
-

CopyItemsFromRequisitionListsOutput

-
-
-
-
Description
-

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
- - - 
{"requisition_list": RequisitionList}
-
- -
-
-
-
-
-
- Types -
-

CopyProductsBetweenWishlistsOutput

-
-
-
-
Description
-

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
- - - 
{
-  "destination_wishlist": Wishlist,
-  "source_wishlist": Wishlist,
-  "user_errors": [WishListUserInputError]
-}
-
- -
-
-
-
-
-
- Types -
-

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
- - - 
{
-  "available_regions": [Region],
-  "full_name_english": "xyz789",
-  "full_name_locale": "xyz789",
-  "id": "abc123",
-  "three_letter_abbreviation": "xyz789",
-  "two_letter_abbreviation": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

CountryCodeEnum

-
-
-
-
Description
-

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
-

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

SZ

- 		Swaziland
-

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
- - - 
"AF"
-
- -
-
-
-
-
-
- Types -
-

CreateCompanyOutput

-
-
-
-
Description
-

Contains the response to the request to create a company.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- company - - - Company! - - The new company instance.
-
-
-
-
-
Example
- - - 
{"company": Company}
-
- -
-
-
-
-
-
- Types -
-

CreateCompanyRoleOutput

-
-
-
-
Description
-

Contains the response to the request to create a company role.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- role - - - CompanyRole! - - The new company role instance.
-
-
-
-
-
Example
- - - 
{"role": CompanyRole}
-
- -
-
-
-
-
-
- Types -
-

CreateCompanyTeamOutput

-
-
-
-
Description
-

Contains the response to the request to create a company team.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- team - - - CompanyTeam! - - The new company team instance.
-
-
-
-
-
Example
- - - 
{"team": CompanyTeam}
-
- -
-
-
-
-
-
- Types -
-

CreateCompanyUserOutput

-
-
-
-
Description
-

Contains the response to the request to create a company user.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- user - - - Customer! - - The new company user instance.
-
-
-
-
-
Example
- - - 
{"user": Customer}
-
- -
-
-
-
-
-
- Types -
-

CreateCompareListInput

-
-
-
-
Description
-

Contains an array of product IDs to use for creating a compare list.

-
-
-
Fields
- - - - - - - - - - - - - -
Input FieldDescription
- products - - - [ID] - - -

An array of product IDs to add to the compare list.

-
-
-
-
-
-
Example
- - - 
{"products": [4]}
-
- -
-
-
-
-
-
- Types -
-

CreateGiftRegistryInput

-
-
-
-
Description
-

Defines a new gift registry.

-
-
-
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
- - - 
{
-  "dynamic_attributes": [
-    GiftRegistryDynamicAttributeInput
-  ],
-  "event_name": "abc123",
-  "gift_registry_type_uid": 4,
-  "message": "abc123",
-  "privacy_settings": "PRIVATE",
-  "registrants": [AddGiftRegistryRegistrantInput],
-  "shipping_address": GiftRegistryShippingAddressInput,
-  "status": "ACTIVE"
-}
-
- -
-
-
-
-
-
- Types -
-

CreateGiftRegistryOutput

-
-
-
-
Description
-

Contains the results of a request to create a gift registry.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- gift_registry - - - GiftRegistry - - The newly-created gift registry.
-
-
-
-
-
Example
- - - 
{"gift_registry": GiftRegistry}
-
- -
-
-
-
-
-
- Types -
-

CreatePayflowProTokenOutput

-
-
-
-
Description
-

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
- - - 
{
-  "response_message": "abc123",
-  "result": 987,
-  "result_code": 987,
-  "secure_token": "xyz789",
-  "secure_token_id": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

CreateProductReviewInput

-
-
-
-
Description
-

Defines a new product review.

-
-
-
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
- - - 
{
-  "nickname": "xyz789",
-  "ratings": [ProductReviewRatingInput],
-  "sku": "xyz789",
-  "summary": "xyz789",
-  "text": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

CreateProductReviewOutput

-
-
-
-
Description
-

Contains the completed product review.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- review - - - ProductReview! - - Product review details.
-
-
-
-
-
Example
- - - 
{"review": ProductReview}
-
- -
-
-
-
-
-
- Types -
-

CreatePurchaseOrderApprovalRuleConditionAmountInput

-
-
-
-
Description
-

Specifies the amount and currency to evaluate.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Input FieldDescription
- currency - - - CurrencyEnum! - - -

Purchase order approval rule condition amount currency.

-
- value - - - Float! - - -

Purchase order approval rule condition amount value.

-
-
-
-
-
-
Example
- - - 
{"currency": "AFN", "value": 987.65}
-
- -
-
-
-
-
-
- Types -
-

CreatePurchaseOrderApprovalRuleConditionInput

-
-
-
-
Description
-

Defines a set of conditions that apply to a rule.

-
-
-
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
- - - 
{
-  "amount": CreatePurchaseOrderApprovalRuleConditionAmountInput,
-  "attribute": "GRAND_TOTAL",
-  "operator": "MORE_THAN",
-  "quantity": 987
-}
-
- -
-
-
-
-
-
- Types -
-

CreateRequisitionListInput

-
-
-
-
Description
-

An input object that identifies and describes a new requisition list.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Input FieldDescription
- description - - - String - - -

An optional description of the requisition list.

-
- name - - - String! - - -

The name assigned to the requisition list.

-
-
-
-
-
-
Example
- - - 
{
-  "description": "abc123",
-  "name": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

CreateRequisitionListOutput

-
-
-
-
Description
-

Output of the request to create a requisition list.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- requisition_list - - - RequisitionList - - The created requisition list.
-
-
-
-
-
Example
- - - 
{"requisition_list": RequisitionList}
-
- -
-
-
-
-
-
- Types -
-

CreateWishlistInput

-
-
-
-
Description
-

Defines the name and visibility of a new wish list.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Input FieldDescription
- name - - - String! - - -

The name of the new wish list.

-
- visibility - - - WishlistVisibilityEnum! - - -

Indicates whether the wish list is public or private.

-
-
-
-
-
-
Example
- - - 
{"name": "xyz789", "visibility": "PUBLIC"}
-
- -
-
-
-
-
-
- Types -
-

CreateWishlistOutput

-
-
-
-
Description
-

Contains the wish list.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- wishlist - - - Wishlist! - - The newly-created wish list
-
-
-
-
-
Example
- - - 
{"wishlist": Wishlist}
-
- -
-
-
-
-
-
- Types -
-

CreditCardDetailsInput

-
-
-
-
Description
-

Required fields for Payflow Pro and Payments Pro credit card payments.

-
-
-
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
- - - 
{
-  "cc_exp_month": 987,
-  "cc_exp_year": 123,
-  "cc_last_4": 987,
-  "cc_type": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

CreditMemo

-
-
-
-
Description
-

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
- - - 
{
-  "comments": [SalesCommentItem],
-  "id": 4,
-  "items": [CreditMemoItemInterface],
-  "number": "abc123",
-  "total": CreditMemoTotal
-}
-
- -
-
-
-
-
-
- Types -
-

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
- - - 
{
-  "discounts": [Discount],
-  "id": "4",
-  "order_item": OrderItemInterface,
-  "product_name": "abc123",
-  "product_sale_price": Money,
-  "product_sku": "abc123",
-  "quantity_refunded": 987.65
-}
-
- -
-
-
-
-
-
- Types -
-

CreditMemoItemInterface

-
-
-
-
Description
-

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
- - - 
{
-  "discounts": [Discount],
-  "id": "4",
-  "order_item": OrderItemInterface,
-  "product_name": "abc123",
-  "product_sale_price": Money,
-  "product_sku": "abc123",
-  "quantity_refunded": 987.65
-}
-
- -
-
-
-
-
-
- Types -
-

CreditMemoTotal

-
-
-
-
Description
-

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
- - - 
{
-  "adjustment": Money,
-  "base_grand_total": Money,
-  "discounts": [Discount],
-  "grand_total": Money,
-  "shipping_handling": ShippingHandling,
-  "subtotal": Money,
-  "taxes": [TaxItem],
-  "total_shipping": Money,
-  "total_tax": Money
-}
-
- -
-
-
-
-
-
- Types -
-

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 - - - Symbol was missed. Use default_display_currency_code. -
- default_display_currecy_symbol - - - String - - - 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
- - - 
{
-  "available_currency_codes": ["abc123"],
-  "base_currency_code": "xyz789",
-  "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]
-}
-
- -
-
-
-
-
-
- Types -
-

CurrencyEnum

-
-
-
-
Description
-

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
- - - 
"AFN"
-
- -
-
-
-
-
-
- Types -
-

CustomAttributeMetadata

-
-
-
-
Description
-

Defines an array of custom attributes.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- items - - - [Attribute] - - An array of attributes.
-
-
-
-
-
Example
- - - 
{"items": [Attribute]}
-
- -
-
-
-
-
-
- Types -
-

Customer

-
-
-
-
Description
-

Defines the customer name, addresses, and other details.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- addresses - - - [CustomerAddress] - - An array containing the customer's shipping and billing addresses.
- allow_remote_shopping_assistance - - - Boolean! - - Indicates whether the customer has enabled remote shopping assistance.
- compare_list - - - CompareList - - The contents of the customer's compare list.
- created_at - - - String - - Timestamp indicating when the account was created.
- 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. - 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.
-
-
Arguments
-
-
-
- giftRegistryUid - - - ID! - -
-
-
-
-
- group_id - - - Int - - - Customer group should not be exposed in the storefront scenarios. -
- id - - - Int - - The ID assigned to the customer. - id is not needed as part of Customer, because on the server side, it can be identified based on the customer token used for authentication. There is no need to know customer ID on the client side. -
- 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 - -
-
-
Arguments
-
-
-
- filter - - - CustomerOrdersFilterInput - -
-

Defines the filter to use for searching customer orders.

-
-
-
- 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. The default value is 20.

-
-
-
- sort - - - CustomerOrderSortInput - -
-

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

-
-
-
- scope - - - ScopeTypeEnum - -
-

Specifies the scope to search for customer orders. The Store request header identifies the customer's store view code. The default value of STORE limits the search to the value specified in the header. Specify WEBSITE to expand the search to include all customer orders assigned to the website that is defined in the header, or specify GLOBAL to include all customer orders across all websites and stores.

-
-
-
-
- prefix - - - String - - An honorific, such as Dr., Mr., or Mrs.
- purchase_order - - - PurchaseOrder - - Purchase order details.
-
-
Arguments
-
-
-
- uid - - - ID! - -
-
-
-
-
- purchase_order_approval_rule - - - PurchaseOrderApprovalRule - - Details about a single purchase order approval rule.
-
-
Arguments
-
-
-
- uid - - - ID! - -
-
-
-
-
- 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.
-
-
Arguments
-
-
-
- currentPage - - - Int - -
-
-
-
- pageSize - - - Int - -
-
-
-
-
- purchase_orders - - - PurchaseOrders - - A list of purchase orders visible to the customer.
-
-
Arguments
-
-
-
- filter - - - PurchaseOrdersFilterInput - -
-
-
-
- currentPage - - - Int - -
-
-
-
- pageSize - - - Int - -
-
-
-
-
- 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.
-
-
Arguments
-
-
-
- pageSize - - - Int - -
-

The maximum number of results to return at once. The default value is 20.

-
-
-
- currentPage - - - Int - -
-

The page of results to return. The default value is 1.

-
-
-
- filter - - - RequisitionListFilterInput - -
-

The filter to use to limit the number of requisition lists to return.

-
-
-
-
- return - - - Return - - Details about the specified return request from the unique ID for a Return object.
-
-
Arguments
-
-
-
- uid - - - ID! - -
-
-
-
-
- returns - - - Returns - - Information about the customer's return requests.
-
-
Arguments
-
-
-
- pageSize - - - Int - -
-

The maximum number of results to return at once. The default is 20.

-
-
-
- currentPage - - - Int - -
-

The page of results to return. The default is 1.

-
-
-
-
- reviews - - - ProductReviews! - - Contains the customer's product reviews.
-
-
Arguments
-
-
-
- pageSize - - - Int - -
-

The maximum number of results to return at once. The default value is 20.

-
-
-
- currentPage - - - Int - -
-

The page of results to return. The default value is 1.

-
-
-
-
- reward_points - - - RewardPoints - - Customer reward points details.
- role - - - CompanyRole - - The role name and permissions assigned to the company user.
- 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. - Use Customer.wishlists or Customer.wishlist_v2 instead. -
- wishlist_v2 - - - Wishlist - - Retrieve the wish list identified by the unique ID for a Wishlist object.
-
-
Arguments
-
-
-
- id - - - ID! - -
-
-
-
-
- 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.
-
-
Arguments
-
-
-
- pageSize - - - Int - -
-

Specifies the maximum number of results to return at once. This attribute is optional.

-
-
-
- currentPage - - - Int - -
-

Specifies which page of results to return. The default value is 1.

-
-
-
-
-
-
-
-
-
Example
- - - 
{
-  "addresses": [CustomerAddress],
-  "allow_remote_shopping_assistance": false,
-  "compare_list": CompareList,
-  "created_at": "xyz789",
-  "date_of_birth": "abc123",
-  "default_billing": "xyz789",
-  "default_shipping": "xyz789",
-  "dob": "abc123",
-  "email": "xyz789",
-  "firstname": "xyz789",
-  "gender": 987,
-  "gift_registries": [GiftRegistry],
-  "gift_registry": GiftRegistry,
-  "group_id": 123,
-  "id": 987,
-  "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": false,
-  "requisition_lists": RequisitionLists,
-  "return": Return,
-  "returns": Returns,
-  "reviews": ProductReviews,
-  "reward_points": RewardPoints,
-  "role": CompanyRole,
-  "status": "ACTIVE",
-  "store_credit": CustomerStoreCredit,
-  "structure_id": 4,
-  "suffix": "abc123",
-  "taxvat": "xyz789",
-  "team": CompanyTeam,
-  "telephone": "xyz789",
-  "wishlist": Wishlist,
-  "wishlist_v2": Wishlist,
-  "wishlists": [Wishlist]
-}
-
- -
-
-
-
-
-
- Types -
-

CustomerAddress

-
-
-
-
Description
-

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. - Use country_code instead. -
- custom_attributes - - - [CustomerAddressAttribute] - - - Custom attributes should not be put into a container. -
- customer_id - - - Int - - The customer ID - 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.
- 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.
- vat_id - - - String - - The customer's Value-added tax (VAT) number (for corporate customers).
-
-
-
-
-
Example
- - - 
{
-  "city": "abc123",
-  "company": "abc123",
-  "country_code": "AF",
-  "country_id": "xyz789",
-  "custom_attributes": [CustomerAddressAttribute],
-  "customer_id": 123,
-  "default_billing": true,
-  "default_shipping": true,
-  "extension_attributes": [CustomerAddressAttribute],
-  "fax": "abc123",
-  "firstname": "abc123",
-  "id": 987,
-  "lastname": "abc123",
-  "middlename": "abc123",
-  "postcode": "xyz789",
-  "prefix": "abc123",
-  "region": CustomerAddressRegion,
-  "region_id": 987,
-  "street": ["abc123"],
-  "suffix": "xyz789",
-  "telephone": "abc123",
-  "vat_id": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

CustomerAddressAttribute

-
-
-
-
Description
-

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 valuue assigned to the customer address attribute.
-
-
-
-
-
Example
- - - 
{
-  "attribute_code": "abc123",
-  "value": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

CustomerAddressAttributeInput

-
-
-
-
Description
-

Specifies the attribute code and value of a customer attribute.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Input FieldDescription
- attribute_code - - - String! - - -

The name assigned to the attribute.

-
- value - - - String! - - -

The value assigned to the attribute.

-
-
-
-
-
-
Example
- - - 
{
-  "attribute_code": "abc123",
-  "value": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

CustomerAddressInput

-
-
-
-
Description
-

Contains details about a billing or shipping address.

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

Deprecated: use country_code instead.

-
- custom_attributes - - - [CustomerAddressAttributeInput] - - -

Deprecated: Custom attributes should not be put into container.

-
- 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
- - - 
{
-  "city": "abc123",
-  "company": "xyz789",
-  "country_code": "AF",
-  "country_id": "AF",
-  "custom_attributes": [CustomerAddressAttributeInput],
-  "default_billing": true,
-  "default_shipping": false,
-  "fax": "xyz789",
-  "firstname": "abc123",
-  "lastname": "xyz789",
-  "middlename": "abc123",
-  "postcode": "abc123",
-  "prefix": "abc123",
-  "region": CustomerAddressRegionInput,
-  "street": ["abc123"],
-  "suffix": "xyz789",
-  "telephone": "xyz789",
-  "vat_id": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

CustomerAddressRegion

-
-
-
-
Description
-

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
- - - 
{
-  "region": "abc123",
-  "region_code": "abc123",
-  "region_id": 123
-}
-
- -
-
-
-
-
-
- Types -
-

CustomerAddressRegionInput

-
-
-
-
Description
-

Defines the customer's state or province.

-
-
-
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
- - - 
{
-  "region": "abc123",
-  "region_code": "xyz789",
-  "region_id": 987
-}
-
- -
-
-
-
-
-
- Types -
-

CustomerCreateInput

-
-
-
-
Description
-

An input object for creating a customer.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Input FieldDescription
- allow_remote_shopping_assistance - - - Boolean - - -

Indicates whether the customer has enabled remote shopping assistance.

-
- date_of_birth - - - String - - -

The customer's date of birth.

-
- dob - - - String - - -

Deprecated: Use date_of_birth instead.

-
- 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
- - - 
{
-  "allow_remote_shopping_assistance": false,
-  "date_of_birth": "abc123",
-  "dob": "abc123",
-  "email": "xyz789",
-  "firstname": "xyz789",
-  "gender": 987,
-  "is_subscribed": true,
-  "lastname": "xyz789",
-  "middlename": "abc123",
-  "password": "abc123",
-  "prefix": "xyz789",
-  "suffix": "xyz789",
-  "taxvat": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

CustomerDownloadableProduct

-
-
-
-
Description
-

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
- - - 
{
-  "date": "xyz789",
-  "download_url": "abc123",
-  "order_increment_id": "abc123",
-  "remaining_downloads": "xyz789",
-  "status": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

CustomerDownloadableProducts

-
-
-
-
Description
-

Contains a list of downloadable products.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- items - - - [CustomerDownloadableProduct] - - An array of purchased downloadable items.
-
-
-
-
-
Example
- - - 
{"items": [CustomerDownloadableProduct]}
-
- -
-
-
-
-
-
- Types -
-

CustomerInput

-
-
-
-
Description
-

An input object that assigns or updates customer attributes.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Input FieldDescription
- date_of_birth - - - String - - -

The customer's date of birth.

-
- dob - - - String - - -

Deprecated: Use date_of_birth instead.

-
- 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
- - - 
{
-  "date_of_birth": "abc123",
-  "dob": "abc123",
-  "email": "xyz789",
-  "firstname": "xyz789",
-  "gender": 123,
-  "is_subscribed": false,
-  "lastname": "xyz789",
-  "middlename": "abc123",
-  "password": "xyz789",
-  "prefix": "xyz789",
-  "suffix": "abc123",
-  "taxvat": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

CustomerOrder

-
-
-
-
Description
-

Contains details about each of the customer's orders.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- 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 - - - Use the order_date field instead. -
- credit_memos - - - [CreditMemo] - - A list of credit memos.
- 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 - - - Use the totals.grand_total field instead. -
- id - - - ID! - - The unique ID for a CustomerOrder object.
- increment_id - - - String - - - Use the id field instead. -
- invoices - - - [Invoice]! - - A list of invoices for the order.
- 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! - - - Use the number field instead. -
- 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.
-
-
Arguments
-
-
-
- pageSize - - - Int - -
-

The maximum number of results to return at once. The default is 20.

-
-
-
- currentPage - - - Int - -
-

The page of results to return. The default is 1.

-
-
-
-
- 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.
- total - - - OrderTotal - - Details about the calculated totals for this order.
-
-
-
-
-
Example
- - - 
{
-  "billing_address": OrderAddress,
-  "carrier": "abc123",
-  "comments": [SalesCommentItem],
-  "created_at": "xyz789",
-  "credit_memos": [CreditMemo],
-  "gift_message": GiftMessage,
-  "gift_receipt_included": true,
-  "gift_wrapping": GiftWrapping,
-  "grand_total": 987.65,
-  "id": 4,
-  "increment_id": "xyz789",
-  "invoices": [Invoice],
-  "items": [OrderItemInterface],
-  "items_eligible_for_return": [OrderItemInterface],
-  "number": "abc123",
-  "order_date": "xyz789",
-  "order_number": "abc123",
-  "payment_methods": [OrderPaymentMethod],
-  "printed_card_included": true,
-  "returns": Returns,
-  "shipments": [OrderShipment],
-  "shipping_address": OrderAddress,
-  "shipping_method": "xyz789",
-  "status": "xyz789",
-  "total": OrderTotal
-}
-
- -
-
-
-
-
-
- Types -
-

CustomerOrderSortInput

-
-
-
-
Description
-

CustomerOrderSortInput specifies the field to use for sorting search results and indicates whether the results are sorted in ascending or descending order.

-
-
-
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
- - - 
{"sort_direction": "ASC", "sort_field": "NUMBER"}
-
- -
-
-
-
-
-
- Types -
-

CustomerOrderSortableField

-
-
-
-
Description
-

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
- - - 
"NUMBER"
-
- -
-
-
-
-
-
- Types -
-

CustomerOrders

-
-
-
-
Description
-

The collection of orders that match the conditions defined in the filter.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- items - - - [CustomerOrder]! - - An array of customer orders.
- page_info - - - SearchResultPageInfo - - Contains pagination metadata.
- total_count - - - Int - - The total count of customer orders.
-
-
-
-
-
Example
- - - 
{
-  "items": [CustomerOrder],
-  "page_info": SearchResultPageInfo,
-  "total_count": 987
-}
-
- -
-
-
-
-
-
- Types -
-

CustomerOrdersFilterInput

-
-
-
-
Description
-

Identifies the filter to use for filtering orders.

-
-
-
Fields
- - - - - - - - - - - - - -
Input FieldDescription
- number - - - FilterStringTypeInput - - -

Filters by order number.

-
-
-
-
-
-
Example
- - - 
{"number": FilterStringTypeInput}
-
- -
-
-
-
-
-
- Types -
-

CustomerOutput

-
-
-
-
Description
-

Contains details about a newly-created or updated customer.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- customer - - - Customer! - - Customer details after creating or updating a customer.
-
-
-
-
-
Example
- - - 
{"customer": Customer}
-
- -
-
-
-
-
-
- Types -
-

CustomerPaymentTokens

-
-
-
-
Description
-

Contains payment tokens stored in the customer's vault.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- items - - - [PaymentToken]! - - An array of payment tokens.
-
-
-
-
-
Example
- - - 
{"items": [PaymentToken]}
-
- -
-
-
-
-
-
- Types -
-

CustomerStoreCredit

-
-
-
-
Description
-

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.
-
-
Arguments
-
-
-
- pageSize - - - Int - -
-

The maximum number of results to return at once. The default is 20.

-
-
-
- currentPage - - - Int - -
-

The page of results to return. This value is optional. The default is 1.

-
-
-
-
- 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
- - - 
{
-  "balance_history": CustomerStoreCreditHistory,
-  "current_balance": Money,
-  "enabled": false
-}
-
- -
-
-
-
-
-
- Types -
-

CustomerStoreCreditHistory

-
-
-
-
Description
-

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
- - - 
{
-  "items": [CustomerStoreCreditHistoryItem],
-  "page_info": SearchResultPageInfo,
-  "total_count": 123
-}
-
- -
-
-
-
-
-
- Types -
-

CustomerStoreCreditHistoryItem

-
-
-
-
Description
-

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
- - - 
{
-  "action": "xyz789",
-  "actual_balance": Money,
-  "balance_change": Money,
-  "date_time_changed": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

CustomerToken

-
-
-
-
Description
-

Contains a customer authorization token.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- token - - - String - - The customer authorization token.
-
-
-
-
-
Example
- - - 
{"token": "xyz789"}
-
- -
-
-
-
-
-
- Types -
-

CustomerUpdateInput

-
-
-
-
Description
-

An input object for updating a customer.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Input FieldDescription
- allow_remote_shopping_assistance - - - Boolean - - -

Indicates whether the customer has enabled remote shopping assistance.

-
- date_of_birth - - - String - - -

The customer's date of birth.

-
- dob - - - String - - -

Deprecated: Use date_of_birth instead.

-
- 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
- - - 
{
-  "allow_remote_shopping_assistance": true,
-  "date_of_birth": "xyz789",
-  "dob": "xyz789",
-  "firstname": "abc123",
-  "gender": 987,
-  "is_subscribed": true,
-  "lastname": "xyz789",
-  "middlename": "abc123",
-  "prefix": "abc123",
-  "suffix": "abc123",
-  "taxvat": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

CustomizableAreaOption

-
-
-
-
Description
-

Contains information about a text area that is defined as part of a customizable option.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- option_id - - - Int - - Option ID. - 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
- - - 
{
-  "option_id": 987,
-  "product_sku": "abc123",
-  "required": false,
-  "sort_order": 987,
-  "title": "xyz789",
-  "uid": 4,
-  "value": CustomizableAreaValue
-}
-
- -
-
-
-
-
-
- Types -
-

CustomizableAreaValue

-
-
-
-
Description
-

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
- - - 
{
-  "max_characters": 123,
-  "price": 987.65,
-  "price_type": "FIXED",
-  "sku": "xyz789",
-  "uid": "4"
-}
-
- -
-
-
-
-
-
- Types -
-

CustomizableCheckboxOption

-
-
-
-
Description
-

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. - 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
- - - 
{
-  "option_id": 123,
-  "required": false,
-  "sort_order": 987,
-  "title": "xyz789",
-  "uid": "4",
-  "value": [CustomizableCheckboxValue]
-}
-
- -
-
-
-
-
-
- Types -
-

CustomizableCheckboxValue

-
-
-
-
Description
-

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
- - - 
{
-  "option_type_id": 123,
-  "price": 987.65,
-  "price_type": "FIXED",
-  "sku": "xyz789",
-  "sort_order": 123,
-  "title": "xyz789",
-  "uid": 4
-}
-
- -
-
-
-
-
-
- Types -
-

CustomizableDateOption

-
-
-
-
Description
-

Contains information about a date picker that is defined as part of a customizable option.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- option_id - - - Int - - Option ID. - 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
- - - 
{
-  "option_id": 987,
-  "product_sku": "xyz789",
-  "required": false,
-  "sort_order": 987,
-  "title": "xyz789",
-  "uid": 4,
-  "value": CustomizableDateValue
-}
-
- -
-
-
-
-
-
- Types -
-

CustomizableDateTypeEnum

-
-
-
-
Description
-

Defines the customizable date type.

-
-
-
Values
- - - - - - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

DATE

-
-

DATE_TIME

-
-

TIME

-
-
-
-
-
-
Example
- - - 
"DATE"
-
- -
-
-
-
-
-
- Types -
-

CustomizableDateValue

-
-
-
-
Description
-

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
- - - 
{
-  "price": 987.65,
-  "price_type": "FIXED",
-  "sku": "xyz789",
-  "type": "DATE",
-  "uid": 4
-}
-
- -
-
-
-
-
-
- Types -
-

CustomizableDropDownOption

-
-
-
-
Description
-

Contains information about a drop down menu that is defined as part of a customizable option.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- option_id - - - Int - - Option ID. - 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
- - - 
{
-  "option_id": 987,
-  "required": false,
-  "sort_order": 123,
-  "title": "xyz789",
-  "uid": "4",
-  "value": [CustomizableDropDownValue]
-}
-
- -
-
-
-
-
-
- Types -
-

CustomizableDropDownValue

-
-
-
-
Description
-

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
- - - 
{
-  "option_type_id": 123,
-  "price": 987.65,
-  "price_type": "FIXED",
-  "sku": "abc123",
-  "sort_order": 987,
-  "title": "abc123",
-  "uid": "4"
-}
-
- -
-
-
-
-
-
- Types -
-

CustomizableFieldOption

-
-
-
-
Description
-

Contains information about a text field that is defined as part of a customizable option.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- option_id - - - Int - - Option ID. - 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
- - - 
{
-  "option_id": 123,
-  "product_sku": "xyz789",
-  "required": false,
-  "sort_order": 123,
-  "title": "abc123",
-  "uid": "4",
-  "value": CustomizableFieldValue
-}
-
- -
-
-
-
-
-
- Types -
-

CustomizableFieldValue

-
-
-
-
Description
-

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
- - - 
{
-  "max_characters": 987,
-  "price": 123.45,
-  "price_type": "FIXED",
-  "sku": "xyz789",
-  "uid": "4"
-}
-
- -
-
-
-
-
-
- Types -
-

CustomizableFileOption

-
-
-
-
Description
-

Contains information about a file picker that is defined as part of a customizable option.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- option_id - - - Int - - Option ID. - 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
- - - 
{
-  "option_id": 987,
-  "product_sku": "abc123",
-  "required": true,
-  "sort_order": 987,
-  "title": "xyz789",
-  "uid": 4,
-  "value": CustomizableFileValue
-}
-
- -
-
-
-
-
-
- Types -
-

CustomizableFileValue

-
-
-
-
Description
-

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
- - - 
{
-  "file_extension": "abc123",
-  "image_size_x": 123,
-  "image_size_y": 987,
-  "price": 987.65,
-  "price_type": "FIXED",
-  "sku": "abc123",
-  "uid": 4
-}
-
- -
-
-
-
-
-
- Types -
-

CustomizableMultipleOption

-
-
-
-
Description
-

Contains information about a multiselect that is defined as part of a customizable option.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- option_id - - - Int - - Option ID. - 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
- - - 
{
-  "option_id": 987,
-  "required": false,
-  "sort_order": 987,
-  "title": "xyz789",
-  "uid": 4,
-  "value": [CustomizableMultipleValue]
-}
-
- -
-
-
-
-
-
- Types -
-

CustomizableMultipleValue

-
-
-
-
Description
-

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
- - - 
{
-  "option_type_id": 123,
-  "price": 987.65,
-  "price_type": "FIXED",
-  "sku": "xyz789",
-  "sort_order": 123,
-  "title": "xyz789",
-  "uid": 4
-}
-
- -
-
-
-
-
-
- Types -
-

CustomizableOptionInput

-
-
-
-
Description
-

Defines a customizable option.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Input FieldDescription
- id - - - Int - - -

The customizable option ID of the product.

-
- value_string - - - String! - - -

The string value of the option.

-
-
-
-
-
-
Example
- - - 
{"id": 123, "value_string": "abc123"}
-
- -
-
-
-
-
-
- Types -
-

CustomizableOptionInterface

-
-
-
-
Description
-

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. - 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
- - - 
{
-  "option_id": 123,
-  "required": true,
-  "sort_order": 123,
-  "title": "xyz789",
-  "uid": 4
-}
-
- -
-
-
-
-
-
- Types -
-

CustomizableProductInterface

-
-
-
-
Description
-

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 -

-
-

- DownloadableProduct -

-
-

- BundleProduct -

-
-

- GiftCardProduct -

-
-

- ConfigurableProduct -

-
-
-
-
-
-
Example
- - - 
{"options": [CustomizableOptionInterface]}
-
- -
-
-
-
-
-
- Types -
-

CustomizableRadioOption

-
-
-
-
Description
-

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. - 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
- - - 
{
-  "option_id": 987,
-  "required": false,
-  "sort_order": 123,
-  "title": "abc123",
-  "uid": 4,
-  "value": [CustomizableRadioValue]
-}
-
- -
-
-
-
-
-
- Types -
-

CustomizableRadioValue

-
-
-
-
Description
-

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
- - - 
{
-  "option_type_id": 987,
-  "price": 987.65,
-  "price_type": "FIXED",
-  "sku": "abc123",
-  "sort_order": 987,
-  "title": "abc123",
-  "uid": "4"
-}
-
- -
-
-
-
-
-
- Types -
-

DeleteCompanyRoleOutput

-
-
-
-
Description
-

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

DeleteCompanyTeamOutput

-
-
-
-
Description
-

Contains the status of the request to delete a company team.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- success - - - Boolean! - - Indicates whether the delete operation succeeded.
-
-
-
-
-
Example
- - - 
{"success": true}
-
- -
-
-
-
-
-
- Types -
-

DeleteCompanyUserOutput

-
-
-
-
Description
-

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
- - - 
{"success": false}
-
- -
-
-
-
-
-
- Types -
-

DeleteCompareListOutput

-
-
-
-
Description
-

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

DeleteNegotiableQuoteError

-
-
-
-
Types
- - - - - - - - - - - - - - - - - -
Union Types
-

- NegotiableQuoteInvalidStateError -

-
-

- NoSuchEntityUidError -

-
-

- InternalError -

-
-
-
-
-
-
Example
- - - 
NegotiableQuoteInvalidStateError
-
- -
-
-
-
-
-
- Types -
-

DeleteNegotiableQuoteOperationFailure

-
-
-
-
Description
-

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
- - - 
{
-  "errors": [NegotiableQuoteInvalidStateError],
-  "quote_uid": "4"
-}
-
- -
-
-
-
-
-
- Types -
-

DeleteNegotiableQuoteOperationResult

-
-
-
-
Types
- - - - - - - - - - - - - - -
Union Types
-

- NegotiableQuoteUidOperationSuccess -

-
-

- DeleteNegotiableQuoteOperationFailure -

-
-
-
-
-
-
Example
- - - 
NegotiableQuoteUidOperationSuccess
-
- -
-
-
-
-
-
- Types -
-

DeleteNegotiableQuotesInput

-
-
-
-
Fields
- - - - - - - - - - - - - -
Input FieldDescription
- quote_uids - - - [ID]! - - -

A list of unique IDs for NegotiableQuote objects to delete.

-
-
-
-
-
-
Example
- - - 
{"quote_uids": [4]}
-
- -
-
-
-
-
-
- Types -
-

DeleteNegotiableQuotesOutput

-
-
-
-
Description
-

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
-
-
Arguments
-
-
-
- filter - - - NegotiableQuoteFilterInput - -
-

The filter to use to determine which negotiable quotes to delete.

-
-
-
- pageSize - - - Int - -
-

The maximum number of results to return at once. The default value is 20.

-
-
-
- currentPage - - - Int - -
-

The page of results to return. The default value is 1.

-
-
-
- sort - - - NegotiableQuoteSortInput - -
-

The field to use for sorting results.

-
-
-
-
- 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
- - - 
{
-  "negotiable_quotes": NegotiableQuotesOutput,
-  "operation_results": [
-    NegotiableQuoteUidOperationSuccess
-  ],
-  "result_status": "SUCCESS"
-}
-
- -
-
-
-
-
-
- Types -
-

DeletePaymentTokenOutput

-
-
-
-
Description
-

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
- - - 
{
-  "customerPaymentTokens": CustomerPaymentTokens,
-  "result": true
-}
-
- -
-
-
-
-
-
- Types -
-

DeletePurchaseOrderApprovalRuleError

-
-
-
-
Description
-

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
- - - 
{"message": "xyz789", "type": "UNDEFINED"}
-
- -
-
-
-
-
-
- Types -
-

DeletePurchaseOrderApprovalRuleErrorType

-
-
-
-
Values
- - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

UNDEFINED

-
-

NOT_FOUND

-
-
-
-
-
-
Example
- - - 
"UNDEFINED"
-
- -
-
-
-
-
-
- Types -
-

DeletePurchaseOrderApprovalRuleInput

-
-
-
-
Description
-

Specifies the IDs of the approval rules to delete.

-
-
-
Fields
- - - - - - - - - - - - - -
Input FieldDescription
- approval_rule_uids - - - [ID]! - - -

An array of purchase order approval rule IDs.

-
-
-
-
-
-
Example
- - - 
{"approval_rule_uids": [4]}
-
- -
-
-
-
-
-
- Types -
-

DeletePurchaseOrderApprovalRuleOutput

-
-
-
-
Description
-

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
- - - 
{"errors": [DeletePurchaseOrderApprovalRuleError]}
-
- -
-
-
-
-
-
- Types -
-

DeleteRequisitionListItemsOutput

-
-
-
-
Description
-

Output of the request to remove items from the requisition list.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- requisition_list - - - RequisitionList - - The requisition list after removing items.
-
-
-
-
-
Example
- - - 
{"requisition_list": RequisitionList}
-
- -
-
-
-
-
-
- Types -
-

DeleteRequisitionListOutput

-
-
-
-
Description
-

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
- - - 
{"requisition_lists": RequisitionLists, "status": true}
-
- -
-
-
-
-
-
- Types -
-

DeleteWishlistOutput

-
-
-
-
Description
-

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
- - - 
{"status": true, "wishlists": [Wishlist]}
-
- -
-
-
-
-
-
- Types -
-

Discount

-
-
-
-
Description
-

Defines an individual discount. A discount can be applied to the cart as a whole or to an item.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- amount - - - Money! - - The amount of the discount.
- label - - - String! - - A description of the discount.
-
-
-
-
-
Example
- - - 
{
-  "amount": Money,
-  "label": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

DownloadableCartItem

-
-
-
-
Description
-

An implementation for downloadable product cart items.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- customizable_options - - - [SelectedCustomizableOption]! - - An array containing the customizable options the shopper selected.
- errors - - - [CartItemError] - - An array of errors encountered while loading the cart item
- id - - - String! - - - Use uid instead. -
- links - - - [DownloadableProductLinks] - - An array containing information about the links for the downloadable product added to the cart.
- 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
- - - 
{
-  "customizable_options": [SelectedCustomizableOption],
-  "errors": [CartItemError],
-  "id": "xyz789",
-  "links": [DownloadableProductLinks],
-  "prices": CartItemPrices,
-  "product": ProductInterface,
-  "quantity": 123.45,
-  "samples": [DownloadableProductSamples],
-  "uid": "4"
-}
-
- -
-
-
-
-
-
- Types -
-

DownloadableCreditMemoItem

-
-
-
-
Description
-

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
- - - 
{
-  "discounts": [Discount],
-  "downloadable_links": [DownloadableItemsLinks],
-  "id": "4",
-  "order_item": OrderItemInterface,
-  "product_name": "xyz789",
-  "product_sale_price": Money,
-  "product_sku": "xyz789",
-  "quantity_refunded": 123.45
-}
-
- -
-
-
-
-
-
- Types -
-

DownloadableFileTypeEnum

-
-
-
-
Values
- - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

FILE

- 		- sample_url serves to get the downloadable sample -
-

URL

- 		- sample_url serves to get the downloadable sample -
-
-
-
-
-
Example
- - - 
"FILE"
-
- -
-
-
-
-
-
- Types -
-

DownloadableInvoiceItem

-
-
-
-
Description
-

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
- - - 
{
-  "discounts": [Discount],
-  "downloadable_links": [DownloadableItemsLinks],
-  "id": "4",
-  "order_item": OrderItemInterface,
-  "product_name": "xyz789",
-  "product_sale_price": Money,
-  "product_sku": "xyz789",
-  "quantity_invoiced": 123.45
-}
-
- -
-
-
-
- -
-
- Types -
-

DownloadableOrderItem

-
-
-
-
Description
-

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.
- 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_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
- - - 
{
-  "discounts": [Discount],
-  "downloadable_links": [DownloadableItemsLinks],
-  "eligible_for_return": false,
-  "entered_options": [OrderItemOption],
-  "gift_message": GiftMessage,
-  "gift_wrapping": GiftWrapping,
-  "id": 4,
-  "product_name": "abc123",
-  "product_sale_price": Money,
-  "product_sku": "xyz789",
-  "product_type": "abc123",
-  "product_url_key": "xyz789",
-  "quantity_canceled": 987.65,
-  "quantity_invoiced": 123.45,
-  "quantity_ordered": 987.65,
-  "quantity_refunded": 123.45,
-  "quantity_returned": 123.45,
-  "quantity_shipped": 987.65,
-  "selected_options": [OrderItemOption],
-  "status": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

DownloadableProduct

-
-
-
-
Description
-

Defines a product that the shopper downloads.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- activity - - - String - - - Use the custom_attributes field instead. -
- attribute_set_id - - - Int - - The attribute set assigned to the product. - 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.
- category_gear - - - String - - - Use the custom_attributes field instead. -
- climate - - - String - - - Use the custom_attributes field instead. -
- collar - - - String - - - Use the custom_attributes field instead. -
- color - - - Int - - - 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. - The field should not be used on the storefront. -
- crosssell_products - - - [ProductInterface] - - An array of cross-sell products.
- 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.
- eco_collection - - - Int - - - Use the custom_attributes field instead. -
- erin_recommends - - - Int - - - Use the custom_attributes field instead. -
- features_bags - - - String - - - Use the custom_attributes field instead. -
- format - - - Int - - - Use the custom_attributes field instead. -
- gender - - - String - - - Use the custom_attributes field instead. -
- gift_message_available - - - String - - Indicates whether a gift message is available.
- id - - - Int - - The ID number assigned to the product. - 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. - Use the custom_attributes field instead. -
- material - - - String - - - Use the custom_attributes field instead. -
- media_gallery - - - [MediaGalleryInterface] - - An array of media gallery objects.
- media_gallery_entries - - - [MediaGalleryEntry] - - An array of MediaGalleryEntry objects. - 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.
- name - - - String - - The product name. Customers use this name to identify the product.
- new - - - Int - - - Use the custom_attributes field instead. -
- 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.
- pattern - - - String - - - Use the custom_attributes field instead. -
- performance_fabric - - - Int - - - Use the custom_attributes field instead. -
- price - - - ProductPrices - - Indicates the price of an item. - 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.
- purpose - - - Int - - - Use the custom_attributes field instead. -
- 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.
-
-
Arguments
-
-
-
- pageSize - - - Int - -
-

The maximum number of results to return at once. The default is 20.

-
-
-
- currentPage - - - Int - -
-

The page of results to return. The default is 1.

-
-
-
-
- sale - - - Int - - - Use the custom_attributes field instead. -
- short_description - - - ComplexTextValue - - A short description of the product. Its use depends on the theme.
- size - - - Int - - - Use the custom_attributes field instead. -
- sku - - - String - - A number or code assigned to a product to identify the product, options, price, and manufacturer.
- sleeve - - - String - - - Use the custom_attributes field instead. -
- 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. - 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
- strap_bags - - - String - - - Use the custom_attributes field instead. -
- style_bags - - - String - - - Use the custom_attributes field instead. -
- style_bottom - - - String - - - Use the custom_attributes field instead. -
- style_general - - - String - - - Use the custom_attributes field instead. -
- 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. - Use price_tiers for product tier price information. -
- tier_prices - - - [ProductTierPrices] - - An array of ProductTierPrices objects. - 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. - Use __typename instead. -
- uid - - - ID! - - The unique ID for a ProductInterface object.
- updated_at - - - String - - Timestamp indicating when the product was updated. - 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 - - - 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. - The field should not be used on the storefront. -
-
-
-
-
-
Example
- - - 
{
-  "activity": "abc123",
-  "attribute_set_id": 123,
-  "canonical_url": "abc123",
-  "categories": [CategoryInterface],
-  "category_gear": "abc123",
-  "climate": "xyz789",
-  "collar": "xyz789",
-  "color": 123,
-  "country_of_manufacture": "abc123",
-  "created_at": "xyz789",
-  "crosssell_products": [ProductInterface],
-  "description": ComplexTextValue,
-  "downloadable_product_links": [
-    DownloadableProductLinks
-  ],
-  "downloadable_product_samples": [
-    DownloadableProductSamples
-  ],
-  "eco_collection": 123,
-  "erin_recommends": 987,
-  "features_bags": "abc123",
-  "format": 123,
-  "gender": "abc123",
-  "gift_message_available": "abc123",
-  "id": 987,
-  "image": ProductImage,
-  "is_returnable": "abc123",
-  "links_purchased_separately": 123,
-  "links_title": "abc123",
-  "manufacturer": 987,
-  "material": "xyz789",
-  "media_gallery": [MediaGalleryInterface],
-  "media_gallery_entries": [MediaGalleryEntry],
-  "meta_description": "abc123",
-  "meta_keyword": "xyz789",
-  "meta_title": "xyz789",
-  "name": "abc123",
-  "new": 987,
-  "new_from_date": "abc123",
-  "new_to_date": "xyz789",
-  "only_x_left_in_stock": 987.65,
-  "options": [CustomizableOptionInterface],
-  "options_container": "xyz789",
-  "pattern": "xyz789",
-  "performance_fabric": 123,
-  "price": ProductPrices,
-  "price_range": PriceRange,
-  "price_tiers": [TierPrice],
-  "product_links": [ProductLinksInterface],
-  "purpose": 987,
-  "rating_summary": 123.45,
-  "redirect_code": 987,
-  "related_products": [ProductInterface],
-  "relative_url": "xyz789",
-  "review_count": 987,
-  "reviews": ProductReviews,
-  "sale": 987,
-  "short_description": ComplexTextValue,
-  "size": 123,
-  "sku": "abc123",
-  "sleeve": "xyz789",
-  "small_image": ProductImage,
-  "special_from_date": "xyz789",
-  "special_price": 987.65,
-  "special_to_date": "xyz789",
-  "staged": false,
-  "stock_status": "IN_STOCK",
-  "strap_bags": "xyz789",
-  "style_bags": "xyz789",
-  "style_bottom": "abc123",
-  "style_general": "abc123",
-  "swatch_image": "xyz789",
-  "thumbnail": ProductImage,
-  "tier_price": 123.45,
-  "tier_prices": [ProductTierPrices],
-  "type": "CMS_PAGE",
-  "type_id": "xyz789",
-  "uid": "4",
-  "updated_at": "abc123",
-  "upsell_products": [ProductInterface],
-  "url_key": "abc123",
-  "url_path": "abc123",
-  "url_rewrites": [UrlRewrite],
-  "url_suffix": "abc123",
-  "websites": [Website]
-}
-
- -
-
-
-
-
-
- Types -
-

DownloadableProductCartItemInput

-
-
-
-
Description
-

Defines a single downloadable product.

-
-
-
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
- - - 
{
-  "customizable_options": [CustomizableOptionInput],
-  "data": CartItemInput,
-  "downloadable_product_links": [
-    DownloadableProductLinksInput
-  ]
-}
-
- -
-
-
-
- -
-
- Types -
-

DownloadableProductLinksInput

-
-
-
-
Description
-

Contains the link ID for the downloadable product.

-
-
-
Fields
- - - - - - - - - - - - - -
Input FieldDescription
- link_id - - - Int! - - -

The unique ID of the downloadable product link.

-
-
-
-
-
-
Example
- - - 
{"link_id": 987}
-
- -
-
-
-
-
-
- Types -
-

DownloadableProductSamples

-
-
-
-
Description
-

Defines characteristics of a downloadable product.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- id - - - Int - - - This information should not be exposed on frontend. -
- sample_file - - - String - - - sample_url serves to get the downloadable sample -
- sample_type - - - DownloadableFileTypeEnum - - - 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
- - - 
{
-  "id": 123,
-  "sample_file": "xyz789",
-  "sample_type": "FILE",
-  "sample_url": "xyz789",
-  "sort_order": 987,
-  "title": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

DownloadableRequisitionListItem

-
-
-
-
Description
-

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
- - - 
{
-  "customizable_options": [SelectedCustomizableOption],
-  "links": [DownloadableProductLinks],
-  "product": ProductInterface,
-  "quantity": 987.65,
-  "samples": [DownloadableProductSamples],
-  "uid": 4
-}
-
- -
-
-
-
-
-
- Types -
-

DownloadableWishlistItem

-
-
-
-
Description
-

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
- - - 
{
-  "added_at": "abc123",
-  "customizable_options": [SelectedCustomizableOption],
-  "description": "xyz789",
-  "id": 4,
-  "links_v2": [DownloadableProductLinks],
-  "product": ProductInterface,
-  "quantity": 123.45,
-  "samples": [DownloadableProductSamples]
-}
-
- -
-
-
-
-
-
- Types -
-

DynamicBlock

-
-
-
-
Description
-

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
- - - 
{"content": ComplexTextValue, "uid": 4}
-
- -
-
-
-
-
-
- Types -
-

DynamicBlockLocationEnum

-
-
-
-
Description
-

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
- - - 
"CONTENT"
-
- -
-
-
-
-
-
- Types -
-

DynamicBlockTypeEnum

-
-
-
-
Description
-

Indicates the selected Dynamic Blocks Rotator inline widget.

-
-
-
Values
- - - - - - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

SPECIFIED

-
-

CART_PRICE_RULE_RELATED

-
-

CATALOG_PRICE_RULE_RELATED

-
-
-
-
-
-
Example
- - - 
"SPECIFIED"
-
- -
-
-
-
-
-
- Types -
-

DynamicBlocks

-
-
-
-
Description
-

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
- - - 
{
-  "items": [DynamicBlock],
-  "page_info": SearchResultPageInfo,
-  "total_count": 123
-}
-
- -
-
-
-
-
-
- Types -
-

DynamicBlocksFilterInput

-
-
-
-
Description
-

Defines the dynamic block filter. The filter can identify the block type, location and IDs to return.

-
-
-
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
- - - 
{
-  "dynamic_block_uids": ["4"],
-  "locations": ["CONTENT"],
-  "type": "SPECIFIED"
-}
-
- -
-
-
-
-
-
- Types -
-

EnteredCustomAttributeInput

-
-
-
-
Description
-

Contains details about a custom text attribute that the buyer entered.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Input FieldDescription
- attribute_code - - - String! - - -

A string that identifies the entered custom attribute.

-
- value - - - String! - - -

The text or other entered value.

-
-
-
-
-
-
Example
- - - 
{
-  "attribute_code": "abc123",
-  "value": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

EnteredOptionInput

-
-
-
-
Description
-

Defines a customer-entered option.

-
-
-
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
- - - 
{"uid": 4, "value": "xyz789"}
-
- -
-
-
-
-
-
- Types -
-

EntityUrl

-
-
-
-
Description
-

Contains the uid, relative_url, and type attributes.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- canonical_url - - - String - - - 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. - 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
- - - 
{
-  "canonical_url": "xyz789",
-  "entity_uid": "4",
-  "id": 123,
-  "redirectCode": 123,
-  "relative_url": "abc123",
-  "type": "CMS_PAGE"
-}
-
- -
-
-
-
-
-
- Types -
-

ErrorInterface

-
-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- message - - - String! - - The returned error message.
-
-
-
Possible Types
- - - - - - - - - - - - - - - - - -
ErrorInterface Types
-

- NoSuchEntityUidError -

-
-

- InternalError -

-
-

- NegotiableQuoteInvalidStateError -

-
-
-
-
-
-
Example
- - - 
{"message": "xyz789"}
-
- -
-
-
-
-
-
- Types -
-

ExchangeRate

-
-
-
-
Description
-

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
- - - 
{"currency_to": "xyz789", "rate": 987.65}
-
- -
-
-
-
-
-
- Types -
-

FilterEqualTypeInput

-
-
-
-
Description
-

Defines a filter that matches the input exactly.

-
-
-
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
- - - 
{
-  "eq": "abc123",
-  "in": ["abc123"]
-}
-
- -
-
-
-
-
-
- Types -
-

FilterMatchTypeInput

-
-
-
-
Description
-

Defines a filter that performs a fuzzy search.

-
-
-
Fields
- - - - - - - - - - - - - -
Input FieldDescription
- match - - - String - - -

Use this attribute to exactly match the specified string. For example, to filter on a specific SKU, specify a value such as 24-MB01.

-
-
-
-
-
-
Example
- - - 
{"match": "abc123"}
-
- -
-
-
-
-
-
- Types -
-

FilterRangeTypeInput

-
-
-
-
Description
-

Defines a filter that matches a range of values, such as prices or dates.

-
-
-
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
- - - 
{
-  "from": "xyz789",
-  "to": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

FilterStringTypeInput

-
-
-
-
Description
-

Defines a filter for an input string.

-
-
-
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
- - - 
{
-  "eq": "abc123",
-  "in": ["abc123"],
-  "match": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

FilterTypeInput

-
-
-
-
Description
-

Defines the comparison operators that can be used in a filter.

-
-
-
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
- - - 
{
-  "eq": "abc123",
-  "finset": ["xyz789"],
-  "from": "abc123",
-  "gt": "xyz789",
-  "gteq": "xyz789",
-  "in": ["xyz789"],
-  "like": "abc123",
-  "lt": "xyz789",
-  "lteq": "xyz789",
-  "moreq": "abc123",
-  "neq": "abc123",
-  "nin": ["xyz789"],
-  "notnull": "abc123",
-  "null": "xyz789",
-  "to": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

FixedProductTax

-
-
-
-
Description
-

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
- - - 
{
-  "amount": Money,
-  "label": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

FixedProductTaxDisplaySettings

-
-
-
-
Description
-

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
- - - 
"INCLUDE_FPT_WITHOUT_DETAILS"
-
- -
-
-
-
-
-
- Types -
-

Float

-
-
-
-
Description
-

The Float scalar type represents signed double-precision fractional values as specified by - IEEE 754.

-
-
-
-
-
Example
- - - 
123.45
-
- -
-
-
-
-
-
- Types -
-

GenerateCustomerTokenAsAdminInput

-
-
-
-
Description
-

Identifies which customer requires remote shopping assistance.

-
-
-
Fields
- - - - - - - - - - - - - -
Input FieldDescription
- customer_email - - - String! - - -

The email address of the customer requesting remote shopping assistance.

-
-
-
-
-
-
Example
- - - 
{"customer_email": "abc123"}
-
- -
-
-
-
-
-
- Types -
-

GenerateCustomerTokenAsAdminOutput

-
-
-
-
Description
-

Contains the generated customer token.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- customer_token - - - String! - - The generated customer token.
-
-
-
-
-
Example
- - - 
{"customer_token": "xyz789"}
-
- -
-
-
-
-
-
- Types -
-

GiftCardAccount

-
-
-
-
Description
-

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
- - - 
{
-  "balance": Money,
-  "code": "xyz789",
-  "expiration_date": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

GiftCardAccountInput

-
-
-
-
Description
-

Contains the gift card code.

-
-
-
Fields
- - - - - - - - - - - - - -
Input FieldDescription
- gift_card_code - - - String! - - -

The applied gift card code.

-
-
-
-
-
-
Example
- - - 
{"gift_card_code": "abc123"}
-
- -
-
-
-
-
-
- Types -
-

GiftCardAmounts

-
-
-
-
Description
-

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. - 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
- - - 
{
-  "attribute_id": 123,
-  "uid": 4,
-  "value": 123.45,
-  "value_id": 987,
-  "website_id": 987,
-  "website_value": 123.45
-}
-
- -
-
-
-
-
-
- Types -
-

GiftCardCartItem

-
-
-
-
Description
-

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.
- customizable_options - - - [SelectedCustomizableOption]! - - An array of customizations applied to the gift card.
- errors - - - [CartItemError] - - An array of errors encountered while loading the cart item
- id - - - String! - - - Use uid instead. -
- message - - - String - - The message from the sender to the recipient.
- 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
- - - 
{
-  "amount": Money,
-  "customizable_options": [SelectedCustomizableOption],
-  "errors": [CartItemError],
-  "id": "xyz789",
-  "message": "abc123",
-  "prices": CartItemPrices,
-  "product": ProductInterface,
-  "quantity": 987.65,
-  "recipient_email": "abc123",
-  "recipient_name": "xyz789",
-  "sender_email": "abc123",
-  "sender_name": "xyz789",
-  "uid": 4
-}
-
- -
-
-
-
-
-
- Types -
-

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
- - - 
{
-  "discounts": [Discount],
-  "gift_card": GiftCardItem,
-  "id": "4",
-  "order_item": OrderItemInterface,
-  "product_name": "xyz789",
-  "product_sale_price": Money,
-  "product_sku": "abc123",
-  "quantity_refunded": 123.45
-}
-
- -
-
-
-
-
-
- Types -
-

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
- - - 
{
-  "discounts": [Discount],
-  "gift_card": GiftCardItem,
-  "id": 4,
-  "order_item": OrderItemInterface,
-  "product_name": "abc123",
-  "product_sale_price": Money,
-  "product_sku": "abc123",
-  "quantity_invoiced": 987.65
-}
-
- -
-
-
-
-
-
- Types -
-

GiftCardItem

-
-
-
-
Description
-

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
- - - 
{
-  "message": "xyz789",
-  "recipient_email": "abc123",
-  "recipient_name": "abc123",
-  "sender_email": "xyz789",
-  "sender_name": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

GiftCardOptions

-
-
-
-
Description
-

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
- - - 
{
-  "amount": Money,
-  "custom_giftcard_amount": Money,
-  "message": "xyz789",
-  "recipient_email": "xyz789",
-  "recipient_name": "abc123",
-  "sender_email": "xyz789",
-  "sender_name": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

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.
- 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_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
- - - 
{
-  "discounts": [Discount],
-  "eligible_for_return": false,
-  "entered_options": [OrderItemOption],
-  "gift_card": GiftCardItem,
-  "gift_message": GiftMessage,
-  "gift_wrapping": GiftWrapping,
-  "id": "4",
-  "product_name": "abc123",
-  "product_sale_price": Money,
-  "product_sku": "abc123",
-  "product_type": "xyz789",
-  "product_url_key": "xyz789",
-  "quantity_canceled": 987.65,
-  "quantity_invoiced": 987.65,
-  "quantity_ordered": 987.65,
-  "quantity_refunded": 123.45,
-  "quantity_returned": 987.65,
-  "quantity_shipped": 123.45,
-  "selected_options": [OrderItemOption],
-  "status": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

GiftCardProduct

-
-
-
-
Description
-

Defines properties of a gift card.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- activity - - - String - - - Use the custom_attributes field instead. -
- 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. - 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.
- category_gear - - - String - - - Use the custom_attributes field instead. -
- climate - - - String - - - Use the custom_attributes field instead. -
- collar - - - String - - - Use the custom_attributes field instead. -
- color - - - Int - - - 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. - The field should not be used on the storefront. -
- crosssell_products - - - [ProductInterface] - - An array of cross-sell products.
- description - - - ComplexTextValue - - Detailed information about the product. The value can include simple HTML tags.
- eco_collection - - - Int - - - Use the custom_attributes field instead. -
- erin_recommends - - - Int - - - Use the custom_attributes field instead. -
- features_bags - - - String - - - Use the custom_attributes field instead. -
- format - - - Int - - - Use the custom_attributes field instead. -
- gender - - - String - - - Use the custom_attributes field instead. -
- gift_card_options - - - [CustomizableOptionInterface]! - - An array of customizable gift card options.
- gift_message_available - - - String - - Indicates whether a gift message is available.
- 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. - 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. - Use the custom_attributes field instead. -
- material - - - String - - - Use the custom_attributes field instead. -
- media_gallery - - - [MediaGalleryInterface] - - An array of media gallery objects.
- media_gallery_entries - - - [MediaGalleryEntry] - - An array of MediaGalleryEntry objects. - 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.
- name - - - String - - The product name. Customers use this name to identify the product.
- new - - - Int - - - Use the custom_attributes field instead. -
- 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.
- pattern - - - String - - - Use the custom_attributes field instead. -
- performance_fabric - - - Int - - - Use the custom_attributes field instead. -
- price - - - ProductPrices - - Indicates the price of an item. - 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.
- purpose - - - Int - - - Use the custom_attributes field instead. -
- 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.
-
-
Arguments
-
-
-
- pageSize - - - Int - -
-

The maximum number of results to return at once. The default is 20.

-
-
-
- currentPage - - - Int - -
-

The page of results to return. The default is 1.

-
-
-
-
- sale - - - Int - - - Use the custom_attributes field instead. -
- short_description - - - ComplexTextValue - - A short description of the product. Its use depends on the theme.
- size - - - Int - - - Use the custom_attributes field instead. -
- sku - - - String - - A number or code assigned to a product to identify the product, options, price, and manufacturer.
- sleeve - - - String - - - Use the custom_attributes field instead. -
- 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. - 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
- strap_bags - - - String - - - Use the custom_attributes field instead. -
- style_bags - - - String - - - Use the custom_attributes field instead. -
- style_bottom - - - String - - - Use the custom_attributes field instead. -
- style_general - - - String - - - Use the custom_attributes field instead. -
- 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. - Use price_tiers for product tier price information. -
- tier_prices - - - [ProductTierPrices] - - An array of ProductTierPrices objects. - 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. - Use __typename instead. -
- uid - - - ID! - - The unique ID for a ProductInterface object.
- updated_at - - - String - - Timestamp indicating when the product was updated. - 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 - - - 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. - The field should not be used on the storefront. -
- weight - - - Float - - The weight of the item, in units defined by the store.
-
-
-
-
-
Example
- - - 
{
-  "activity": "abc123",
-  "allow_message": false,
-  "allow_open_amount": false,
-  "attribute_set_id": 123,
-  "canonical_url": "abc123",
-  "categories": [CategoryInterface],
-  "category_gear": "abc123",
-  "climate": "abc123",
-  "collar": "xyz789",
-  "color": 123,
-  "country_of_manufacture": "abc123",
-  "created_at": "abc123",
-  "crosssell_products": [ProductInterface],
-  "description": ComplexTextValue,
-  "eco_collection": 987,
-  "erin_recommends": 987,
-  "features_bags": "xyz789",
-  "format": 123,
-  "gender": "abc123",
-  "gift_card_options": [CustomizableOptionInterface],
-  "gift_message_available": "abc123",
-  "giftcard_amounts": [GiftCardAmounts],
-  "giftcard_type": "VIRTUAL",
-  "id": 123,
-  "image": ProductImage,
-  "is_redeemable": true,
-  "is_returnable": "abc123",
-  "lifetime": 123,
-  "manufacturer": 123,
-  "material": "xyz789",
-  "media_gallery": [MediaGalleryInterface],
-  "media_gallery_entries": [MediaGalleryEntry],
-  "message_max_length": 123,
-  "meta_description": "abc123",
-  "meta_keyword": "xyz789",
-  "meta_title": "abc123",
-  "name": "xyz789",
-  "new": 987,
-  "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": "abc123",
-  "pattern": "abc123",
-  "performance_fabric": 987,
-  "price": ProductPrices,
-  "price_range": PriceRange,
-  "price_tiers": [TierPrice],
-  "product_links": [ProductLinksInterface],
-  "purpose": 123,
-  "rating_summary": 123.45,
-  "redirect_code": 987,
-  "related_products": [ProductInterface],
-  "relative_url": "xyz789",
-  "review_count": 123,
-  "reviews": ProductReviews,
-  "sale": 987,
-  "short_description": ComplexTextValue,
-  "size": 123,
-  "sku": "abc123",
-  "sleeve": "xyz789",
-  "small_image": ProductImage,
-  "special_from_date": "abc123",
-  "special_price": 987.65,
-  "special_to_date": "xyz789",
-  "staged": true,
-  "stock_status": "IN_STOCK",
-  "strap_bags": "abc123",
-  "style_bags": "abc123",
-  "style_bottom": "abc123",
-  "style_general": "xyz789",
-  "swatch_image": "abc123",
-  "thumbnail": ProductImage,
-  "tier_price": 123.45,
-  "tier_prices": [ProductTierPrices],
-  "type": "CMS_PAGE",
-  "type_id": "xyz789",
-  "uid": 4,
-  "updated_at": "xyz789",
-  "upsell_products": [ProductInterface],
-  "url_key": "abc123",
-  "url_path": "abc123",
-  "url_rewrites": [UrlRewrite],
-  "url_suffix": "abc123",
-  "websites": [Website],
-  "weight": 123.45
-}
-
- -
-
-
-
-
-
- Types -
-

GiftCardRequisitionListItem

-
-
-
-
Description
-

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
- - - 
{
-  "customizable_options": [SelectedCustomizableOption],
-  "gift_card_options": GiftCardOptions,
-  "product": ProductInterface,
-  "quantity": 123.45,
-  "uid": "4"
-}
-
- -
-
-
-
-
-
- Types -
-

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
- - - 
{
-  "gift_card": GiftCardItem,
-  "id": 4,
-  "order_item": OrderItemInterface,
-  "product_name": "abc123",
-  "product_sale_price": Money,
-  "product_sku": "abc123",
-  "quantity_shipped": 987.65
-}
-
- -
-
-
-
-
-
- Types -
-

GiftCardTypeEnum

-
-
-
-
Description
-

Specifies the gift card type.

-
-
-
Values
- - - - - - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

VIRTUAL

-
-

PHYSICAL

-
-

COMBINED

-
-
-
-
-
-
Example
- - - 
"VIRTUAL"
-
- -
-
-
-
-
-
- Types -
-

GiftCardWishlistItem

-
-
-
-
Description
-

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
- - - 
{
-  "added_at": "abc123",
-  "customizable_options": [SelectedCustomizableOption],
-  "description": "abc123",
-  "gift_card_options": GiftCardOptions,
-  "id": 4,
-  "product": ProductInterface,
-  "quantity": 987.65
-}
-
- -
-
-
-
-
-
- Types -
-

GiftMessage

-
-
-
-
Description
-

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
- - - 
{
-  "from": "xyz789",
-  "message": "abc123",
-  "to": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

GiftMessageInput

-
-
-
-
Description
-

Defines a gift message.

-
-
-
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
- - - 
{
-  "from": "abc123",
-  "message": "abc123",
-  "to": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

GiftOptionsPrices

-
-
-
-
Description
-

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_order - - - Money - - Price of the gift wrapping for the whole order.
- printed_card - - - Money - - Price for the printed card.
-
-
-
-
-
Example
- - - 
{
-  "gift_wrapping_for_items": Money,
-  "gift_wrapping_for_order": Money,
-  "printed_card": Money
-}
-
- -
-
-
-
-
-
- Types -
-

GiftRegistry

-
-
-
-
Description
-

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

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
- - - 
{
-  "code": 4,
-  "group": "EVENT_INFORMATION",
-  "label": "abc123",
-  "value": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

GiftRegistryDynamicAttributeGroup

-
-
-
-
Description
-

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
- - - 
"EVENT_INFORMATION"
-
- -
-
-
-
-
-
- Types -
-

GiftRegistryDynamicAttributeInput

-
-
-
-
Description
-

Defines a dynamic attribute.

-
-
-
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
- - - 
{
-  "code": "4",
-  "value": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

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
- - - 
{
-  "code": "4",
-  "label": "xyz789",
-  "value": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

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
- - - 
{
-  "attribute_group": "xyz789",
-  "code": 4,
-  "input_type": "xyz789",
-  "is_required": false,
-  "label": "abc123",
-  "sort_order": 123
-}
-
- -
-
-
-
-
-
- Types -
-

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
- - - 
{
-  "attribute_group": "abc123",
-  "code": "4",
-  "input_type": "xyz789",
-  "is_required": false,
-  "label": "abc123",
-  "sort_order": 987
-}
-
- -
-
-
-
-
-
- Types -
-

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
- - - 
{
-  "created_at": "abc123",
-  "note": "abc123",
-  "product": ProductInterface,
-  "quantity": 123.45,
-  "quantity_fulfilled": 123.45,
-  "uid": 4
-}
-
- -
-
-
-
-
-
- Types -
-

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
- - - 
{
-  "created_at": "abc123",
-  "note": "xyz789",
-  "product": ProductInterface,
-  "quantity": 987.65,
-  "quantity_fulfilled": 123.45,
-  "uid": 4
-}
-
- -
-
-
-
-
-
- Types -
-

GiftRegistryItemUserErrorInterface

-
-
-
-
Description
-

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
- - - 
{
-  "status": true,
-  "user_errors": [GiftRegistryItemsUserError]
-}
-
- -
-
-
-
-
-
- Types -
-

GiftRegistryItemsUserError

-
-
-
-
Description
-

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
- - - 
{
-  "code": "OUT_OF_STOCK",
-  "gift_registry_item_uid": "4",
-  "gift_registry_uid": "4",
-  "message": "xyz789",
-  "product_uid": "4"
-}
-
- -
-
-
-
-
-
- Types -
-

GiftRegistryItemsUserErrorType

-
-
-
-
Description
-

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
- - - 
"OUT_OF_STOCK"
-
- -
-
-
-
-
-
- Types -
-

GiftRegistryOutputInterface

-
-
-
-
Description
-

Contains the customer's gift registry.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- gift_registry - - - GiftRegistry - - The gift registry.
-
-
-
Possible Types
- - - - - - - - - - - -
GiftRegistryOutputInterface Types
-

- MoveCartItemsToGiftRegistryOutput -

-
-
-
-
-
-
Example
- - - 
{"gift_registry": GiftRegistry}
-
- -
-
-
-
-
-
- Types -
-

GiftRegistryPrivacySettings

-
-
-
-
Description
-

Defines the privacy setting of the gift registry.

-
-
-
Values
- - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

PRIVATE

-
-

PUBLIC

-
-
-
-
-
-
Example
- - - 
"PRIVATE"
-
- -
-
-
-
-
-
- Types -
-

GiftRegistryRegistrant

-
-
-
-
Description
-

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
- - - 
{
-  "dynamic_attributes": [
-    GiftRegistryRegistrantDynamicAttribute
-  ],
-  "email": "abc123",
-  "firstname": "abc123",
-  "lastname": "abc123",
-  "uid": 4
-}
-
- -
-
-
-
-
-
- Types -
-

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
- - - 
{
-  "code": "4",
-  "label": "xyz789",
-  "value": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

GiftRegistrySearchResult

-
-
-
-
Description
-

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
- - - 
{
-  "event_date": "abc123",
-  "event_title": "xyz789",
-  "gift_registry_uid": 4,
-  "location": "xyz789",
-  "name": "xyz789",
-  "type": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

GiftRegistryShippingAddressInput

-
-
-
-
Description
-

Defines a shipping address for a gift registry. Specify either address_data or the address_id. If both are provided, validation will fail.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Input FieldDescription
- address_data - - - CustomerAddressInput - - -

Defines the shipping address for this gift registry.

-
- address_id - - - ID - - -

The ID assigned to this customer address.

-
-
-
-
-
-
Example
- - - 
{"address_data": CustomerAddressInput, "address_id": 4}
-
- -
-
-
-
-
-
- Types -
-

GiftRegistryStatus

-
-
-
-
Description
-

Defines the status of the gift registry.

-
-
-
Values
- - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

ACTIVE

-
-

INACTIVE

-
-
-
-
-
-
Example
- - - 
"ACTIVE"
-
- -
-
-
-
-
-
- Types -
-

GiftRegistryType

-
-
-
-
Description
-

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
- - - 
{
-  "dynamic_attributes_metadata": [
-    GiftRegistryDynamicAttributeMetadataInterface
-  ],
-  "label": "abc123",
-  "uid": 4
-}
-
- -
-
-
-
-
-
- Types -
-

GiftWrapping

-
-
-
-
Description
-

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. - 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
- - - 
{
-  "design": "xyz789",
-  "id": 4,
-  "image": GiftWrappingImage,
-  "price": Money,
-  "uid": 4
-}
-
- -
-
-
-
-
-
- Types -
-

GiftWrappingImage

-
-
-
-
Description
-

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
- - - 
{
-  "label": "xyz789",
-  "url": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

GroupedProduct

-
-
-
-
Description
-

Defines a grouped product, which consists of simple standalone products that are presented as a group.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- activity - - - String - - - Use the custom_attributes field instead. -
- attribute_set_id - - - Int - - The attribute set assigned to the product. - 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.
- category_gear - - - String - - - Use the custom_attributes field instead. -
- climate - - - String - - - Use the custom_attributes field instead. -
- collar - - - String - - - Use the custom_attributes field instead. -
- color - - - Int - - - 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. - The field should not be used on the storefront. -
- crosssell_products - - - [ProductInterface] - - An array of cross-sell products.
- description - - - ComplexTextValue - - Detailed information about the product. The value can include simple HTML tags.
- eco_collection - - - Int - - - Use the custom_attributes field instead. -
- erin_recommends - - - Int - - - Use the custom_attributes field instead. -
- features_bags - - - String - - - Use the custom_attributes field instead. -
- format - - - Int - - - Use the custom_attributes field instead. -
- gender - - - String - - - Use the custom_attributes field instead. -
- gift_message_available - - - String - - Indicates whether a gift message is available.
- id - - - Int - - The ID number assigned to the product. - 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. - Use the custom_attributes field instead. -
- material - - - String - - - Use the custom_attributes field instead. -
- media_gallery - - - [MediaGalleryInterface] - - An array of media gallery objects.
- media_gallery_entries - - - [MediaGalleryEntry] - - An array of MediaGalleryEntry objects. - 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.
- name - - - String - - The product name. Customers use this name to identify the product.
- new - - - Int - - - Use the custom_attributes field instead. -
- 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.
- pattern - - - String - - - Use the custom_attributes field instead. -
- performance_fabric - - - Int - - - Use the custom_attributes field instead. -
- price - - - ProductPrices - - Indicates the price of an item. - 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.
- purpose - - - Int - - - Use the custom_attributes field instead. -
- 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.
-
-
Arguments
-
-
-
- pageSize - - - Int - -
-

The maximum number of results to return at once. The default is 20.

-
-
-
- currentPage - - - Int - -
-

The page of results to return. The default is 1.

-
-
-
-
- sale - - - Int - - - Use the custom_attributes field instead. -
- short_description - - - ComplexTextValue - - A short description of the product. Its use depends on the theme.
- size - - - Int - - - Use the custom_attributes field instead. -
- sku - - - String - - A number or code assigned to a product to identify the product, options, price, and manufacturer.
- sleeve - - - String - - - Use the custom_attributes field instead. -
- 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. - 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
- strap_bags - - - String - - - Use the custom_attributes field instead. -
- style_bags - - - String - - - Use the custom_attributes field instead. -
- style_bottom - - - String - - - Use the custom_attributes field instead. -
- style_general - - - String - - - Use the custom_attributes field instead. -
- 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. - Use price_tiers for product tier price information. -
- tier_prices - - - [ProductTierPrices] - - An array of ProductTierPrices objects. - 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. - Use __typename instead. -
- uid - - - ID! - - The unique ID for a ProductInterface object.
- updated_at - - - String - - Timestamp indicating when the product was updated. - 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 - - - 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. - The field should not be used on the storefront. -
- weight - - - Float - - The weight of the item, in units defined by the store.
-
-
-
-
-
Example
- - - 
{
-  "activity": "xyz789",
-  "attribute_set_id": 123,
-  "canonical_url": "xyz789",
-  "categories": [CategoryInterface],
-  "category_gear": "xyz789",
-  "climate": "xyz789",
-  "collar": "abc123",
-  "color": 123,
-  "country_of_manufacture": "abc123",
-  "created_at": "xyz789",
-  "crosssell_products": [ProductInterface],
-  "description": ComplexTextValue,
-  "eco_collection": 123,
-  "erin_recommends": 123,
-  "features_bags": "abc123",
-  "format": 123,
-  "gender": "xyz789",
-  "gift_message_available": "abc123",
-  "id": 987,
-  "image": ProductImage,
-  "is_returnable": "abc123",
-  "items": [GroupedProductItem],
-  "manufacturer": 987,
-  "material": "xyz789",
-  "media_gallery": [MediaGalleryInterface],
-  "media_gallery_entries": [MediaGalleryEntry],
-  "meta_description": "abc123",
-  "meta_keyword": "xyz789",
-  "meta_title": "abc123",
-  "name": "xyz789",
-  "new": 987,
-  "new_from_date": "xyz789",
-  "new_to_date": "xyz789",
-  "only_x_left_in_stock": 123.45,
-  "options_container": "xyz789",
-  "pattern": "xyz789",
-  "performance_fabric": 123,
-  "price": ProductPrices,
-  "price_range": PriceRange,
-  "price_tiers": [TierPrice],
-  "product_links": [ProductLinksInterface],
-  "purpose": 123,
-  "rating_summary": 123.45,
-  "redirect_code": 987,
-  "related_products": [ProductInterface],
-  "relative_url": "abc123",
-  "review_count": 123,
-  "reviews": ProductReviews,
-  "sale": 987,
-  "short_description": ComplexTextValue,
-  "size": 987,
-  "sku": "abc123",
-  "sleeve": "abc123",
-  "small_image": ProductImage,
-  "special_from_date": "xyz789",
-  "special_price": 123.45,
-  "special_to_date": "xyz789",
-  "staged": true,
-  "stock_status": "IN_STOCK",
-  "strap_bags": "abc123",
-  "style_bags": "xyz789",
-  "style_bottom": "xyz789",
-  "style_general": "abc123",
-  "swatch_image": "abc123",
-  "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": "xyz789",
-  "url_path": "abc123",
-  "url_rewrites": [UrlRewrite],
-  "url_suffix": "xyz789",
-  "websites": [Website],
-  "weight": 987.65
-}
-
- -
-
-
-
-
-
- Types -
-

GroupedProductItem

-
-
-
-
Description
-

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
- - - 
{
-  "position": 123,
-  "product": ProductInterface,
-  "qty": 987.65
-}
-
- -
-
-
-
-
-
- Types -
-

GroupedProductWishlistItem

-
-
-
-
Description
-

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
- - - 
{
-  "added_at": "abc123",
-  "customizable_options": [SelectedCustomizableOption],
-  "description": "xyz789",
-  "id": "4",
-  "product": ProductInterface,
-  "quantity": 987.65
-}
-
- -
-
-
-
-
-
- Types -
-

HostedProInput

-
-
-
-
Description
-

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.

-
-
-
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
- - - 
{
-  "cancel_url": "xyz789",
-  "return_url": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

HostedProUrl

-
-
-
-
Description
-

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

HostedProUrlInput

-
-
-
-
Description
-

Contains the required input to request the secure URL for Payments Pro Hosted Solution payment.

-
-
-
Fields
- - - - - - - - - - - - - -
Input FieldDescription
- cart_id - - - String! - - -

The unique ID that identifies the shopper's cart.

-
-
-
-
-
-
Example
- - - 
{"cart_id": "abc123"}
-
- -
-
-
-
-
-
- Types -
-

HttpQueryParameter

-
-
-
-
Description
-

Contains target path parameters.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- name - - - String - - A parameter name.
- value - - - String - - A parameter value.
-
-
-
-
-
Example
- - - 
{
-  "name": "abc123",
-  "value": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

ID

-
-
-
-
Description
-

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
- - - 
"4"
-
- -
-
-
-
-
-
- Types -
-

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
- - - 
{
-  "thumbnail": "abc123",
-  "value": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

Int

-
-
-
-
Description
-

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

-
-
-
-
-
Example
- - - 
123
-
- -
-
-
-
-
-
- Types -
-

InternalError

-
-
-
-
Description
-

Contains an error message when an internal error occurred.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- message - - - String! - - The returned error message.
-
-
-
-
-
Example
- - - 
{"message": "xyz789"}
-
- -
-
-
-
-
-
- Types -
-

Invoice

-
-
-
-
Description
-

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
- - - 
{
-  "comments": [SalesCommentItem],
-  "id": 4,
-  "items": [InvoiceItemInterface],
-  "number": "abc123",
-  "total": InvoiceTotal
-}
-
- -
-
-
-
-
-
- Types -
-

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
- - - 
{
-  "discounts": [Discount],
-  "id": 4,
-  "order_item": OrderItemInterface,
-  "product_name": "abc123",
-  "product_sale_price": Money,
-  "product_sku": "abc123",
-  "quantity_invoiced": 123.45
-}
-
- -
-
-
-
-
-
- Types -
-

InvoiceItemInterface

-
-
-
-
Description
-

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
- - - 
{
-  "discounts": [Discount],
-  "id": "4",
-  "order_item": OrderItemInterface,
-  "product_name": "abc123",
-  "product_sale_price": Money,
-  "product_sku": "xyz789",
-  "quantity_invoiced": 123.45
-}
-
- -
-
-
-
-
-
- Types -
-

InvoiceTotal

-
-
-
-
Description
-

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
- - - 
{
-  "base_grand_total": Money,
-  "discounts": [Discount],
-  "grand_total": Money,
-  "shipping_handling": ShippingHandling,
-  "subtotal": Money,
-  "taxes": [TaxItem],
-  "total_shipping": Money,
-  "total_tax": Money
-}
-
- -
-
-
-
-
-
- Types -
-

IsCompanyAdminEmailAvailableOutput

-
-
-
-
Description
-

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

IsCompanyEmailAvailableOutput

-
-
-
-
Description
-

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

IsCompanyRoleNameAvailableOutput

-
-
-
-
Description
-

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

IsCompanyUserEmailAvailableOutput

-
-
-
-
Description
-

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
- - - 
{"is_email_available": false}
-
- -
-
-
-
-
-
- Types -
-

IsEmailAvailableOutput

-
-
-
-
Description
-

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

ItemSelectedBundleOption

-
-
-
-
Description
-

A list of options of the selected bundle product.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- id - - - ID! - - The unique ID for a ItemSelectedBundleOption object. - 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
- - - 
{
-  "id": "4",
-  "label": "abc123",
-  "uid": 4,
-  "values": [ItemSelectedBundleOptionValue]
-}
-
- -
-
-
-
-
-
- Types -
-

ItemSelectedBundleOptionValue

-
-
-
-
Description
-

A list of values for the selected bundle product.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- id - - - ID! - - The unique ID for a ItemSelectedBundleOptionValue object. - 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
- - - 
{
-  "id": "4",
-  "price": Money,
-  "product_name": "xyz789",
-  "product_sku": "xyz789",
-  "quantity": 987.65,
-  "uid": 4
-}
-
- -
-
-
-
-
-
- Types -
-

KeyValue

-
-
-
-
Description
-

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
- - - 
{
-  "name": "abc123",
-  "value": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

LayerFilter

-
-
-
-
Description
-

Contains information for rendering layered navigation.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- filter_items - - - [LayerFilterItemInterface] - - An array of filter items. - Use Aggregation.options instead. -
- filter_items_count - - - Int - - The count of filter items in filter group. - Use Aggregation.count instead. -
- name - - - String - - The name of a layered navigation filter. - Use Aggregation.label instead. -
- request_var - - - String - - The request variable name for a filter query. - Use Aggregation.attribute_code instead. -
-
-
-
-
-
Example
- - - 
{
-  "filter_items": [LayerFilterItemInterface],
-  "filter_items_count": 123,
-  "name": "abc123",
-  "request_var": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

LayerFilterItem

-
-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- items_count - - - Int - - The count of items per filter. - Use AggregationOption.count instead. -
- label - - - String - - The label for a filter. - Use AggregationOption.label instead. -
- value_string - - - String - - The value of a filter request variable to be used in query. - Use AggregationOption.value instead. -
-
-
-
-
-
Example
- - - 
{
-  "items_count": 123,
-  "label": "abc123",
-  "value_string": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

LayerFilterItemInterface

-
-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- items_count - - - Int - - The count of items per filter. - Use AggregationOption.count instead. -
- label - - - String - - The label for a filter. - Use AggregationOption.label instead. -
- value_string - - - String - - The value of a filter request variable to be used in query. - Use AggregationOption.value instead. -
-
-
-
Possible Types
- - - - - - - - - - - - - - -
LayerFilterItemInterface Types
-

- LayerFilterItem -

-
-

- SwatchLayerFilterItem -

-
-
-
-
-
-
Example
- - - 
{
-  "items_count": 987,
-  "label": "xyz789",
-  "value_string": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

MediaGalleryEntry

-
-
-
-
Description
-

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. - 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
- - - 
{
-  "content": ProductMediaGalleryEntriesContent,
-  "disabled": true,
-  "file": "abc123",
-  "id": 987,
-  "label": "abc123",
-  "media_type": "xyz789",
-  "position": 987,
-  "types": ["abc123"],
-  "uid": 4,
-  "video_content": ProductMediaGalleryEntriesVideoContent
-}
-
- -
-
-
-
-
-
- Types -
-

MediaGalleryInterface

-
-
-
-
Description
-

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.
- url - - - String - - The URL of the product image or video.
-
-
-
Possible Types
- - - - - - - - - - - - - - -
MediaGalleryInterface Types
-

- ProductImage -

-
-

- ProductVideo -

-
-
-
-
-
-
Example
- - - 
{
-  "disabled": false,
-  "label": "xyz789",
-  "position": 987,
-  "url": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

Money

-
-
-
-
Description
-

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
- - - 
{"currency": "AFN", "value": 123.45}
-
- -
-
-
-
-
-
- Types -
-

MoveCartItemsToGiftRegistryOutput

-
-
-
-
Description
-

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
- - - 
{
-  "gift_registry": GiftRegistry,
-  "status": false,
-  "user_errors": [GiftRegistryItemsUserError]
-}
-
- -
-
-
-
-
-
- Types -
-

MoveItemsBetweenRequisitionListsInput

-
-
-
-
Description
-

An input object that defines the items in a requisition list to be moved.

-
-
-
Fields
- - - - - - - - - - - - - -
Input FieldDescription
- requisitionListItemUids - - - [ID]! - - -

An array of IDs representing products moved from one requisition list to another.

-
-
-
-
-
-
Example
- - - 
{"requisitionListItemUids": ["4"]}
-
- -
-
-
-
-
-
- Types -
-

MoveItemsBetweenRequisitionListsOutput

-
-
-
-
Description
-

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
- - - 
{
-  "destination_requisition_list": RequisitionList,
-  "source_requisition_list": RequisitionList
-}
-
- -
-
-
-
-
-
- Types -
-

MoveProductsBetweenWishlistsOutput

-
-
-
-
Description
-

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
- - - 
{
-  "destination_wishlist": Wishlist,
-  "source_wishlist": Wishlist,
-  "user_errors": [WishListUserInputError]
-}
-
- -
-
-
-
-
-
- Types -
-

NegotiableQuote

-
-
-
-
Description
-

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
- - - 
{
-  "available_payment_methods": [AvailablePaymentMethod],
-  "billing_address": NegotiableQuoteBillingAddress,
-  "buyer": NegotiableQuoteUser,
-  "comments": [NegotiableQuoteComment],
-  "created_at": "xyz789",
-  "email": "xyz789",
-  "history": [NegotiableQuoteHistoryEntry],
-  "is_virtual": true,
-  "items": [CartItemInterface],
-  "name": "xyz789",
-  "prices": CartPrices,
-  "selected_payment_method": SelectedPaymentMethod,
-  "shipping_addresses": [NegotiableQuoteShippingAddress],
-  "status": "SUBMITTED",
-  "total_quantity": 123.45,
-  "uid": 4,
-  "updated_at": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

NegotiableQuoteAddressCountry

-
-
-
-
Description
-

Defines the company's country.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- code - - - String! - - The address country code.
- label - - - String! - - The display name of the region.
-
-
-
-
-
Example
- - - 
{
-  "code": "xyz789",
-  "label": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

NegotiableQuoteAddressInput

-
-
-
-
Description
-

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

-
-
-
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
- - - 
{
-  "city": "xyz789",
-  "company": "abc123",
-  "country_code": "abc123",
-  "firstname": "abc123",
-  "lastname": "abc123",
-  "postcode": "abc123",
-  "region": "abc123",
-  "region_id": 987,
-  "save_in_address_book": true,
-  "street": ["abc123"],
-  "telephone": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

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
- - - 
{
-  "city": "abc123",
-  "company": "xyz789",
-  "country": NegotiableQuoteAddressCountry,
-  "firstname": "abc123",
-  "lastname": "abc123",
-  "postcode": "abc123",
-  "region": NegotiableQuoteAddressRegion,
-  "street": ["abc123"],
-  "telephone": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

NegotiableQuoteAddressRegion

-
-
-
-
Description
-

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
- - - 
{
-  "code": "xyz789",
-  "label": "xyz789",
-  "region_id": 123
-}
-
- -
-
-
-
-
-
- Types -
-

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
- - - 
{
-  "city": "abc123",
-  "company": "abc123",
-  "country": NegotiableQuoteAddressCountry,
-  "firstname": "abc123",
-  "lastname": "abc123",
-  "postcode": "xyz789",
-  "region": NegotiableQuoteAddressRegion,
-  "street": ["xyz789"],
-  "telephone": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

NegotiableQuoteBillingAddressInput

-
-
-
-
Description
-

Defines the billing address.

-
-
-
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
- - - 
{
-  "address": NegotiableQuoteAddressInput,
-  "customer_address_uid": 4,
-  "same_as_shipping": false,
-  "use_for_shipping": true
-}
-
- -
-
-
-
-
-
- Types -
-

NegotiableQuoteComment

-
-
-
-
Description
-

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
- - - 
{
-  "author": NegotiableQuoteUser,
-  "created_at": "abc123",
-  "creator_type": "BUYER",
-  "text": "abc123",
-  "uid": "4"
-}
-
- -
-
-
-
-
-
- Types -
-

NegotiableQuoteCommentCreatorType

-
-
-
-
Values
- - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

BUYER

-
-

SELLER

-
-
-
-
-
-
Example
- - - 
"BUYER"
-
- -
-
-
-
-
-
- Types -
-

NegotiableQuoteCommentInput

-
-
-
-
Description
-

Contains the commend provided by the buyer.

-
-
-
Fields
- - - - - - - - - - - - - -
Input FieldDescription
- comment - - - String! - - -

The comment provided by the buyer.

-
-
-
-
-
-
Example
- - - 
{"comment": "abc123"}
-
- -
-
-
-
-
-
- Types -
-

NegotiableQuoteCustomLogChange

-
-
-
-
Description
-

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
- - - 
{
-  "new_value": "abc123",
-  "old_value": "xyz789",
-  "title": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

NegotiableQuoteFilterInput

-
-
-
-
Description
-

Defines a filter to limit the negotiable quotes to return.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Input FieldDescription
- ids - - - FilterEqualTypeInput - - -

Filter by the ID of one or more negotiable quotes.

-
- name - - - FilterMatchTypeInput - - -

Filter by the negotiable quote name.

-
-
-
-
-
-
Example
- - - 
{
-  "ids": FilterEqualTypeInput,
-  "name": FilterMatchTypeInput
-}
-
- -
-
-
-
-
-
- Types -
-

NegotiableQuoteHistoryChanges

-
-
-
-
Description
-

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
- - - 
{
-  "comment_added": NegotiableQuoteHistoryCommentChange,
-  "custom_changes": NegotiableQuoteCustomLogChange,
-  "expiration": NegotiableQuoteHistoryExpirationChange,
-  "products_removed": NegotiableQuoteHistoryProductsRemovedChange,
-  "statuses": NegotiableQuoteHistoryStatusesChange,
-  "total": NegotiableQuoteHistoryTotalChange
-}
-
- -
-
-
-
-
-
- Types -
-

NegotiableQuoteHistoryCommentChange

-
-
-
-
Description
-

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

NegotiableQuoteHistoryEntry

-
-
-
-
Description
-

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
- - - 
{
-  "author": NegotiableQuoteUser,
-  "change_type": "CREATED",
-  "changes": NegotiableQuoteHistoryChanges,
-  "created_at": "xyz789",
-  "uid": "4"
-}
-
- -
-
-
-
-
-
- Types -
-

NegotiableQuoteHistoryEntryChangeType

-
-
-
-
Values
- - - - - - - - - - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

CREATED

-
-

UPDATED

-
-

CLOSED

-
-

UPDATED_BY_SYSTEM

-
-
-
-
-
-
Example
- - - 
"CREATED"
-
- -
-
-
-
-
-
- Types -
-

NegotiableQuoteHistoryExpirationChange

-
-
-
-
Description
-

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
- - - 
{
-  "new_expiration": "abc123",
-  "old_expiration": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

NegotiableQuoteHistoryProductsRemovedChange

-
-
-
-
Description
-

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
- - - 
{
-  "products_removed_from_catalog": [4],
-  "products_removed_from_quote": [ProductInterface]
-}
-
- -
-
-
-
-
-
- Types -
-

NegotiableQuoteHistoryStatusChange

-
-
-
-
Description
-

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
- - - 
{"new_status": "SUBMITTED", "old_status": "SUBMITTED"}
-
- -
-
-
-
-
-
- Types -
-

NegotiableQuoteHistoryStatusesChange

-
-
-
-
Description
-

Contains a list of status changes that occurred for the negotiable quote.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- changes - - - [NegotiableQuoteHistoryStatusChange]! - - A list of status changes.
-
-
-
-
-
Example
- - - 
{"changes": [NegotiableQuoteHistoryStatusChange]}
-
- -
-
-
-
-
-
- Types -
-

NegotiableQuoteHistoryTotalChange

-
-
-
-
Description
-

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
- - - 
{
-  "new_price": Money,
-  "old_price": Money
-}
-
- -
-
-
-
-
-
- Types -
-

NegotiableQuoteInvalidStateError

-
-
-
-
Description
-

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
- - - 
{"message": "xyz789"}
-
- -
-
-
-
-
-
- Types -
-

NegotiableQuoteItemQuantityInput

-
-
-
-
Description
-

Specifies the updated quantity of an item.

-
-
-
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
- - - 
{"quantity": 123.45, "quote_item_uid": "4"}
-
- -
-
-
-
-
-
- Types -
-

NegotiableQuotePaymentMethodInput

-
-
-
-
Description
-

Defines the payment method to be applied to the negotiable quote.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Input FieldDescription
- code - - - String! - - -

Payment method code

-
- purchase_order_number - - - String - - -

The purchase order number. Optional for most payment methods.

-
-
-
-
-
-
Example
- - - 
{
-  "code": "xyz789",
-  "purchase_order_number": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

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
- - - 
{
-  "available_shipping_methods": [AvailableShippingMethod],
-  "city": "xyz789",
-  "company": "xyz789",
-  "country": NegotiableQuoteAddressCountry,
-  "firstname": "abc123",
-  "lastname": "xyz789",
-  "postcode": "abc123",
-  "region": NegotiableQuoteAddressRegion,
-  "selected_shipping_method": SelectedShippingMethod,
-  "street": ["xyz789"],
-  "telephone": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

NegotiableQuoteShippingAddressInput

-
-
-
-
Description
-

Defines shipping addresses for the negotiable quote.

-
-
-
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
- - - 
{
-  "address": NegotiableQuoteAddressInput,
-  "customer_address_uid": "4",
-  "customer_notes": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

NegotiableQuoteSortInput

-
-
-
-
Description
-

Defines the field to use to sort a list of negotiable quotes.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Input FieldDescription
- sort_direction - - - SortEnum! - - -

Whether to return results in ascending or descending order.

-
- sort_field - - - NegotiableQuoteSortableField! - - -

The specified sort field.

-
-
-
-
-
-
Example
- - - 
{"sort_direction": "ASC", "sort_field": "QUOTE_NAME"}
-
- -
-
-
-
-
-
- Types -
-

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
- - - 
"QUOTE_NAME"
-
- -
-
-
-
-
-
- Types -
-

NegotiableQuoteStatus

-
-
-
-
Values
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

SUBMITTED

-
-

PENDING

-
-

UPDATED

-
-

OPEN

-
-

ORDERED

-
-

CLOSED

-
-

DECLINED

-
-

EXPIRED

-
-
-
-
-
-
Example
- - - 
"SUBMITTED"
-
- -
-
-
-
-
-
- Types -
-

NegotiableQuoteUidNonFatalResultInterface

-
-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- quote_uid - - - ID! - - The unique ID of a NegotiableQuote object.
-
-
-
Possible Types
- - - - - - - - - - - -
NegotiableQuoteUidNonFatalResultInterface Types
-

- NegotiableQuoteUidOperationSuccess -

-
-
-
-
-
-
Example
- - - 
{"quote_uid": 4}
-
- -
-
-
-
-
-
- Types -
-

NegotiableQuoteUidOperationSuccess

-
-
-
-
Description
-

Contains details about a successful operation on a negotiable quote.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- quote_uid - - - ID! - - The unique ID of a NegotiableQuote object.
-
-
-
-
-
Example
- - - 
{"quote_uid": "4"}
-
- -
-
-
-
-
-
- Types -
-

NegotiableQuoteUser

-
-
-
-
Description
-

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
- - - 
{
-  "firstname": "xyz789",
-  "lastname": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

NegotiableQuotesOutput

-
-
-
-
Description
-

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
- - - 
{
-  "items": [NegotiableQuote],
-  "page_info": SearchResultPageInfo,
-  "sort_fields": SortFields,
-  "total_count": 123
-}
-
- -
-
-
-
-
-
- Types -
-

NoSuchEntityUidError

-
-
-
-
Description
-

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
- - - 
{
-  "message": "xyz789",
-  "uid": "4"
-}
-
- -
-
-
-
-
-
- Types -
-

Order

-
-
-
-
Description
-

Contains the order ID.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- order_id - - - String - - - Use order_number instead. -
- order_number - - - String! - - The unique ID for an Order object.
-
-
-
-
-
Example
- - - 
{
-  "order_id": "xyz789",
-  "order_number": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

OrderAddress

-
-
-
-
Description
-

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.
- 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
- - - 
{
-  "city": "abc123",
-  "company": "xyz789",
-  "country_code": "AF",
-  "fax": "abc123",
-  "firstname": "abc123",
-  "lastname": "abc123",
-  "middlename": "xyz789",
-  "postcode": "abc123",
-  "prefix": "abc123",
-  "region": "abc123",
-  "region_id": "4",
-  "street": ["abc123"],
-  "suffix": "abc123",
-  "telephone": "xyz789",
-  "vat_id": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

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.
- 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_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
- - - 
{
-  "discounts": [Discount],
-  "eligible_for_return": false,
-  "entered_options": [OrderItemOption],
-  "gift_message": GiftMessage,
-  "gift_wrapping": GiftWrapping,
-  "id": 4,
-  "product_name": "abc123",
-  "product_sale_price": Money,
-  "product_sku": "xyz789",
-  "product_type": "xyz789",
-  "product_url_key": "xyz789",
-  "quantity_canceled": 123.45,
-  "quantity_invoiced": 987.65,
-  "quantity_ordered": 987.65,
-  "quantity_refunded": 123.45,
-  "quantity_returned": 987.65,
-  "quantity_shipped": 123.45,
-  "selected_options": [OrderItemOption],
-  "status": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

OrderItemInterface

-
-
-
-
Description
-

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.
- 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_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
-

- DownloadableOrderItem -

-
-

- BundleOrderItem -

-
-

- GiftCardOrderItem -

-
-

- OrderItem -

-
-
-
-
-
-
Example
- - - 
{
-  "discounts": [Discount],
-  "eligible_for_return": true,
-  "entered_options": [OrderItemOption],
-  "gift_message": GiftMessage,
-  "gift_wrapping": GiftWrapping,
-  "id": 4,
-  "product_name": "xyz789",
-  "product_sale_price": Money,
-  "product_sku": "abc123",
-  "product_type": "xyz789",
-  "product_url_key": "xyz789",
-  "quantity_canceled": 987.65,
-  "quantity_invoiced": 987.65,
-  "quantity_ordered": 123.45,
-  "quantity_refunded": 987.65,
-  "quantity_returned": 987.65,
-  "quantity_shipped": 123.45,
-  "selected_options": [OrderItemOption],
-  "status": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

OrderItemOption

-
-
-
-
Description
-

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
- - - 
{
-  "label": "abc123",
-  "value": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

OrderPaymentMethod

-
-
-
-
Description
-

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
- - - 
{
-  "additional_data": [KeyValue],
-  "name": "xyz789",
-  "type": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

OrderShipment

-
-
-
-
Description
-

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
- - - 
{
-  "comments": [SalesCommentItem],
-  "id": "4",
-  "items": [ShipmentItemInterface],
-  "number": "xyz789",
-  "tracking": [ShipmentTracking]
-}
-
- -
-
-
-
-
-
- Types -
-

OrderTotal

-
-
-
-
Description
-

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.
- grand_total - - - Money! - - The final total amount, including shipping, discounts, and 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.
- taxes - - - [TaxItem] - - The order tax details.
- total_giftcard - - - Money - - The gift card balance applied to the order.
- total_shipping - - - Money! - - The shipping amount for the order.
- total_tax - - - Money! - - The amount of tax applied to the order.
-
-
-
-
-
Example
- - - 
{
-  "base_grand_total": Money,
-  "discounts": [Discount],
-  "grand_total": Money,
-  "shipping_handling": ShippingHandling,
-  "subtotal": Money,
-  "taxes": [TaxItem],
-  "total_giftcard": Money,
-  "total_shipping": Money,
-  "total_tax": Money
-}
-
- -
-
-
-
-
-
- Types -
-

PayflowExpressInput

-
-
-
-
Description
-

Contains required input for Payflow Express Checkout payments.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Input FieldDescription
- payer_id - - - String! - - -

The unique ID of the PayPal user.

-
- token - - - String! - - -

The token returned by the createPaypalExpressToken mutation.

-
-
-
-
-
-
Example
- - - 
{
-  "payer_id": "xyz789",
-  "token": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

PayflowLinkInput

-
-
-
-
Description
-

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.

-
-
-
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
- - - 
{
-  "cancel_url": "xyz789",
-  "error_url": "xyz789",
-  "return_url": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

PayflowLinkMode

-
-
-
-
Description
-

Indicates the mode for payment. Applies to the Payflow Link and Payments Advanced payment methods.

-
-
-
Values
- - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

TEST

-
-

LIVE

-
-
-
-
-
-
Example
- - - 
"TEST"
-
- -
-
-
-
-
-
- Types -
-

PayflowLinkToken

-
-
-
-
Description
-

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
- - - 
{
-  "mode": "TEST",
-  "paypal_url": "xyz789",
-  "secure_token": "abc123",
-  "secure_token_id": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

PayflowLinkTokenInput

-
-
-
-
Description
-

Contains information required to fetch payment token information for the Payflow Link and Payments Advanced payment methods.

-
-
-
Fields
- - - - - - - - - - - - - -
Input FieldDescription
- cart_id - - - String! - - -

The unique ID that identifies the customer's cart.

-
-
-
-
-
-
Example
- - - 
{"cart_id": "abc123"}
-
- -
-
-
-
-
-
- Types -
-

PayflowProInput

-
-
-
-
Description
-

Contains input for the Payflow Pro and Payments Pro payment methods.

-
-
-
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
- - - 
{
-  "cc_details": CreditCardDetailsInput,
-  "is_active_payment_token_enabler": true
-}
-
- -
-
-
-
-
-
- Types -
-

PayflowProResponseInput

-
-
-
-
Description
-

Input required to complete payment. Applies to Payflow Pro and Payments Pro payment methods.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Input FieldDescription
- cart_id - - - String! - - -

The unique ID that identifies the shopper's cart.

-
- paypal_payload - - - String! - - -

The payload returned from PayPal.

-
-
-
-
-
-
Example
- - - 
{
-  "cart_id": "abc123",
-  "paypal_payload": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

PayflowProResponseOutput

-
-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- cart - - - Cart! - - The cart with the updated selected payment method.
-
-
-
-
-
Example
- - - 
{"cart": Cart}
-
- -
-
-
-
-
-
- Types -
-

PayflowProTokenInput

-
-
-
-
Description
-

Contains input required to fetch payment token information for the Payflow Pro and Payments Pro payment methods.

-
-
-
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
- - - 
{
-  "cart_id": "abc123",
-  "urls": PayflowProUrlInput
-}
-
- -
-
-
-
-
-
- Types -
-

PayflowProUrlInput

-
-
-
-
Description
-

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.

-
-
-
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
- - - 
{
-  "cancel_url": "abc123",
-  "error_url": "xyz789",
-  "return_url": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

PaymentMethodInput

-
-
-
-
Description
-

Defines the payment method.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Input FieldDescription
- braintree - - - BraintreeInput - -
- braintree_cc_vault - - - BraintreeCcVaultInput - -
- 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.

-
- 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
- - - 
{
-  "braintree": BraintreeInput,
-  "braintree_cc_vault": BraintreeCcVaultInput,
-  "code": "abc123",
-  "hosted_pro": HostedProInput,
-  "payflow_express": PayflowExpressInput,
-  "payflow_link": PayflowLinkInput,
-  "payflowpro": PayflowProInput,
-  "payflowpro_cc_vault": VaultTokenInput,
-  "paypal_express": PaypalExpressInput,
-  "purchase_order_number": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

PaymentToken

-
-
-
-
Description
-

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
- - - 
{
-  "details": "xyz789",
-  "payment_method_code": "xyz789",
-  "public_hash": "xyz789",
-  "type": "card"
-}
-
- -
-
-
-
-
-
- Types -
-

PaymentTokenTypeEnum

-
-
-
-
Description
-

The list of available payment token types.

-
-
-
Values
- - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

card

- 		phpcs:ignore Magento2.GraphQL.ValidArgumentName
-

account

- 		phpcs:ignore Magento2.GraphQL.ValidArgumentName
-
-
-
-
-
Example
- - - 
"card"
-
- -
-
-
-
-
-
- Types -
-

PaypalExpressInput

-
-
-
-
Description
-

Contains required input for Express Checkout and Payments Standard payments.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Input FieldDescription
- payer_id - - - String! - - -

The unique ID of the PayPal user.

-
- token - - - String! - - -

The token returned by the createPaypalExpressToken mutation.

-
-
-
-
-
-
Example
- - - 
{
-  "payer_id": "xyz789",
-  "token": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

PaypalExpressTokenInput

-
-
-
-
Description
-

Defines the attributes required to receive a payment token for Express Checkout and Payments Standard payment methods.

-
-
-
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
- - - 
{
-  "cart_id": "xyz789",
-  "code": "abc123",
-  "express_button": true,
-  "urls": PaypalExpressUrlsInput,
-  "use_paypal_credit": false
-}
-
- -
-
-
-
-
-
- Types -
-

PaypalExpressTokenOutput

-
-
-
-
Description
-

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
- - - 
{
-  "paypal_urls": PaypalExpressUrlList,
-  "token": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

PaypalExpressUrlList

-
-
-
-
Description
-

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
- - - 
{
-  "edit": "abc123",
-  "start": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

PaypalExpressUrlsInput

-
-
-
-
Description
-

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.

-
-
-
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
- - - 
{
-  "cancel_url": "abc123",
-  "pending_url": "xyz789",
-  "return_url": "abc123",
-  "success_url": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

PhysicalProductInterface

-
-
-
-
Description
-

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 -

-
-

- BundleProduct -

-
-

- GiftCardProduct -

-
-

- GroupedProduct -

-
-

- ConfigurableProduct -

-
-
-
-
-
-
Example
- - - 
{"weight": 123.45}
-
- -
-
-
-
-
-
- Types -
-

PickupLocation

-
-
-
-
Description
-

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
- - - 
{
-  "city": "abc123",
-  "contact_name": "xyz789",
-  "country_id": "abc123",
-  "description": "xyz789",
-  "email": "xyz789",
-  "fax": "abc123",
-  "latitude": 987.65,
-  "longitude": 123.45,
-  "name": "xyz789",
-  "phone": "xyz789",
-  "pickup_location_code": "abc123",
-  "postcode": "abc123",
-  "region": "abc123",
-  "region_id": 123,
-  "street": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

PickupLocationFilterInput

-
-
-
-
Description
-

PickupLocationFilterInput defines the list of attributes and filters for the search.

-
-
-
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
- - - 
{
-  "city": FilterTypeInput,
-  "country_id": FilterTypeInput,
-  "name": FilterTypeInput,
-  "pickup_location_code": FilterTypeInput,
-  "postcode": FilterTypeInput,
-  "region": FilterTypeInput,
-  "region_id": FilterTypeInput,
-  "street": FilterTypeInput
-}
-
- -
-
-
-
-
-
- Types -
-

PickupLocationSortInput

-
-
-
-
Description
-

PickupLocationSortInput specifies attribute to use for sorting search results and indicates whether the results are sorted in ascending or descending order.

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

PickupLocations

-
-
-
-
Description
-

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
- - - 
{
-  "items": [PickupLocation],
-  "page_info": SearchResultPageInfo,
-  "total_count": 987
-}
-
- -
-
-
-
-
-
- Types -
-

PlaceNegotiableQuoteOrderInput

-
-
-
-
Description
-

Specifies the negotiable quote to convert to an order.

-
-
-
Fields
- - - - - - - - - - - - - -
Input FieldDescription
- quote_uid - - - ID! - - -

The unique ID of a NegotiableQuote object.

-
-
-
-
-
-
Example
- - - 
{"quote_uid": "4"}
-
- -
-
-
-
-
-
- Types -
-

PlaceNegotiableQuoteOrderOutput

-
-
-
-
Description
-

An output object that returns the generated order.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- order - - - Order! - - Contains the generated order number.
-
-
-
-
-
Example
- - - 
{"order": Order}
-
- -
-
-
-
-
-
- Types -
-

PlaceOrderForPurchaseOrderInput

-
-
-
-
Description
-

Specifies the purchase order to convert to an order.

-
-
-
Fields
- - - - - - - - - - - - - -
Input FieldDescription
- purchase_order_uid - - - ID! - - -

The unique ID of a purchase order.

-
-
-
-
-
-
Example
- - - 
{"purchase_order_uid": "4"}
-
- -
-
-
-
-
-
- Types -
-

PlaceOrderForPurchaseOrderOutput

-
-
-
-
Description
-

Contains the results of the request to place an order.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- order - - - CustomerOrder! - - Placed order.
-
-
-
-
-
Example
- - - 
{"order": CustomerOrder}
-
- -
-
-
-
-
-
- Types -
-

PlaceOrderInput

-
-
-
-
Description
-

Specifies the quote to be converted to an order.

-
-
-
Fields
- - - - - - - - - - - - - -
Input FieldDescription
- cart_id - - - String! - - -

The unique ID of a Cart object.

-
-
-
-
-
-
Example
- - - 
{"cart_id": "xyz789"}
-
- -
-
-
-
-
-
- Types -
-

PlaceOrderOutput

-
-
-
-
Description
-

Contains the results of the request to place an order.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- order - - - Order! - - The ID of the order.
-
-
-
-
-
Example
- - - 
{"order": Order}
-
- -
-
-
-
-
-
- Types -
-

PlacePurchaseOrderInput

-
-
-
-
Description
-

Specifies the quote to be converted to a purchase order.

-
-
-
Fields
- - - - - - - - - - - - - -
Input FieldDescription
- cart_id - - - String! - - -

The unique ID of a Cart object.

-
-
-
-
-
-
Example
- - - 
{"cart_id": "abc123"}
-
- -
-
-
-
-
-
- Types -
-

PlacePurchaseOrderOutput

-
-
-
-
Description
-

Contains the results of the request to place a purchase order.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- purchase_order - - - PurchaseOrder! - - Placed purchase order.
-
-
-
-
-
Example
- - - 
{"purchase_order": PurchaseOrder}
-
- -
-
-
-
-
-
- Types -
-

Price

-
-
-
-
Description
-

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. - Use ProductPrice instead. -
- amount - - - Money - - The price of a product plus a three-letter currency code. - Use ProductPrice instead. -
-
-
-
-
-
Example
- - - 
{
-  "adjustments": [PriceAdjustment],
-  "amount": Money
-}
-
- -
-
-
-
-
-
- Types -
-

PriceAdjustment

-
-
-
-
Description
-

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. - PriceAdjustment is deprecated. -
- description - - - PriceAdjustmentDescriptionEnum - - Indicates whether the entity described by the code attribute is included or excluded from the adjustment. - PriceAdjustment is deprecated. -
-
-
-
-
-
Example
- - - 
{
-  "amount": Money,
-  "code": "TAX",
-  "description": "INCLUDED"
-}
-
- -
-
-
-
-
-
- Types -
-

PriceAdjustmentCodesEnum

-
-
-
-
Description
-

PriceAdjustment.code is deprecated.

-
-
-
Values
- - - - - - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

TAX

- 		- PriceAdjustmentCodesEnum is deprecated. Tax is included or excluded in the price. Tax is not shown separately in Catalog. -
-

WEEE

- 		- WEEE code is deprecated. Use fixed_product_taxes.label instead. -
-

WEEE_TAX

- 		- Use fixed_product_taxes instead. Tax is included or excluded in price. The tax is not shown separtely in Catalog. -
-
-
-
-
-
Example
- - - 
"TAX"
-
- -
-
-
-
-
-
- Types -
-

PriceAdjustmentDescriptionEnum

-
-
-
-
Description
-

PriceAdjustmentDescriptionEnum is deprecated. States whether a price adjustment is included or excluded.

-
-
-
Values
- - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

INCLUDED

-
-

EXCLUDED

-
-
-
-
-
-
Example
- - - 
"INCLUDED"
-
- -
-
-
-
-
-
- Types -
-

PriceRange

-
-
-
-
Description
-

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
- - - 
{
-  "maximum_price": ProductPrice,
-  "minimum_price": ProductPrice
-}
-
- -
-
-
-
-
-
- Types -
-

PriceTypeEnum

-
-
-
-
Description
-

Defines the price type.

-
-
-
Values
- - - - - - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

FIXED

-
-

PERCENT

-
-

DYNAMIC

-
-
-
-
-
-
Example
- - - 
"FIXED"
-
- -
-
-
-
-
-
- Types -
-

PriceViewEnum

-
-
-
-
Description
-

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
- - - 
"PRICE_RANGE"
-
- -
-
-
-
-
-
- Types -
-

ProductAttribute

-
-
-
-
Description
-

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
- - - 
{
-  "code": "abc123",
-  "value": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

ProductAttributeFilterInput

-
-
-
-
Description
-

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.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Input FieldDescription
- activity - - - FilterEqualTypeInput - - -

Attribute label: Activity

-
- category_gear - - - FilterEqualTypeInput - - -

Attribute label: Category Gear

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

-
- climate - - - FilterEqualTypeInput - - -

Attribute label: Climate

-
- collar - - - FilterEqualTypeInput - - -

Attribute label: Collar

-
- color - - - FilterEqualTypeInput - - -

Attribute label: Color

-
- description - - - FilterMatchTypeInput - - -

Attribute label: Description

-
- eco_collection - - - FilterEqualTypeInput - - -

Attribute label: Eco Collection

-
- erin_recommends - - - FilterEqualTypeInput - - -

Attribute label: Erin Recommends

-
- features_bags - - - FilterEqualTypeInput - - -

Attribute label: Features

-
- format - - - FilterEqualTypeInput - - -

Attribute label: Format

-
- gender - - - FilterEqualTypeInput - - -

Attribute label: Gender

-
- material - - - FilterEqualTypeInput - - -

Attribute label: Material

-
- name - - - FilterMatchTypeInput - - -

Attribute label: Product Name

-
- new - - - FilterEqualTypeInput - - -

Attribute label: New

-
- pattern - - - FilterEqualTypeInput - - -

Attribute label: Pattern

-
- performance_fabric - - - FilterEqualTypeInput - - -

Attribute label: Performance Fabric

-
- price - - - FilterRangeTypeInput - - -

Attribute label: Price

-
- purpose - - - FilterEqualTypeInput - - -

Attribute label: Purpose

-
- sale - - - FilterEqualTypeInput - - -

Attribute label: Sale

-
- short_description - - - FilterMatchTypeInput - - -

Attribute label: Short Description

-
- size - - - FilterEqualTypeInput - - -

Attribute label: Size

-
- sku - - - FilterEqualTypeInput - - -

Attribute label: SKU

-
- sleeve - - - FilterEqualTypeInput - - -

Attribute label: Sleeve

-
- strap_bags - - - FilterEqualTypeInput - - -

Attribute label: Strap/Handle

-
- style_bags - - - FilterEqualTypeInput - - -

Attribute label: Style Bags

-
- style_bottom - - - FilterEqualTypeInput - - -

Attribute label: Style Bottom

-
- style_general - - - FilterEqualTypeInput - - -

Attribute label: Style General

-
- url_key - - - FilterEqualTypeInput - - -

The part of the URL that identifies the product

-
-
-
-
-
-
Example
- - - 
{
-  "activity": FilterEqualTypeInput,
-  "category_gear": FilterEqualTypeInput,
-  "category_id": FilterEqualTypeInput,
-  "category_uid": FilterEqualTypeInput,
-  "climate": FilterEqualTypeInput,
-  "collar": FilterEqualTypeInput,
-  "color": FilterEqualTypeInput,
-  "description": FilterMatchTypeInput,
-  "eco_collection": FilterEqualTypeInput,
-  "erin_recommends": FilterEqualTypeInput,
-  "features_bags": FilterEqualTypeInput,
-  "format": FilterEqualTypeInput,
-  "gender": FilterEqualTypeInput,
-  "material": FilterEqualTypeInput,
-  "name": FilterMatchTypeInput,
-  "new": FilterEqualTypeInput,
-  "pattern": FilterEqualTypeInput,
-  "performance_fabric": FilterEqualTypeInput,
-  "price": FilterRangeTypeInput,
-  "purpose": FilterEqualTypeInput,
-  "sale": FilterEqualTypeInput,
-  "short_description": FilterMatchTypeInput,
-  "size": FilterEqualTypeInput,
-  "sku": FilterEqualTypeInput,
-  "sleeve": FilterEqualTypeInput,
-  "strap_bags": FilterEqualTypeInput,
-  "style_bags": FilterEqualTypeInput,
-  "style_bottom": FilterEqualTypeInput,
-  "style_general": FilterEqualTypeInput,
-  "url_key": FilterEqualTypeInput
-}
-
- -
-
-
-
-
-
- Types -
-

ProductAttributeSortInput

-
-
-
-
Description
-

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

-
-
-
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
- - - 
{"name": "ASC", "position": "ASC", "price": "ASC", "relevance": "ASC"}
-
- -
-
-
-
-
-
- Types -
-

ProductDiscount

-
-
-
-
Description
-

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
- - - 
{"amount_off": 987.65, "percent_off": 987.65}
-
- -
-
-
-
-
-
- Types -
-

ProductFilterInput

-
-
-
-
Description
-

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.

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

ProductImage

-
-
-
-
Description
-

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.
- url - - - String - - The URL of the product image or video.
-
-
-
-
-
Example
- - - 
{
-  "disabled": true,
-  "label": "abc123",
-  "position": 987,
-  "url": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

ProductInfoInput

-
-
-
-
Description
-

Product Information used for Pickup Locations search.

-
-
-
Fields
- - - - - - - - - - - - - -
Input FieldDescription
- sku - - - String! - - -

Product SKU.

-
-
-
-
-
-
Example
- - - 
{"sku": "abc123"}
-
- -
-
-
-
-
-
- Types -
-

ProductInterface

-
-
-
-
Description
-

Contains fields that are common to all types of products.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- activity - - - String - - - Use the custom_attributes field instead. -
- attribute_set_id - - - Int - - The attribute set assigned to the product. - 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.
- category_gear - - - String - - - Use the custom_attributes field instead. -
- climate - - - String - - - Use the custom_attributes field instead. -
- collar - - - String - - - Use the custom_attributes field instead. -
- color - - - Int - - - 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. - The field should not be used on the storefront. -
- crosssell_products - - - [ProductInterface] - - An array of cross-sell products.
- description - - - ComplexTextValue - - Detailed information about the product. The value can include simple HTML tags.
- eco_collection - - - Int - - - Use the custom_attributes field instead. -
- erin_recommends - - - Int - - - Use the custom_attributes field instead. -
- features_bags - - - String - - - Use the custom_attributes field instead. -
- format - - - Int - - - Use the custom_attributes field instead. -
- gender - - - String - - - Use the custom_attributes field instead. -
- gift_message_available - - - String - - Indicates whether a gift message is available.
- id - - - Int - - The ID number assigned to the product. - 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. - Use the custom_attributes field instead. -
- material - - - String - - - Use the custom_attributes field instead. -
- media_gallery - - - [MediaGalleryInterface] - - An array of media gallery objects.
- media_gallery_entries - - - [MediaGalleryEntry] - - An array of MediaGalleryEntry objects. - 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.
- name - - - String - - The product name. Customers use this name to identify the product.
- new - - - Int - - - Use the custom_attributes field instead. -
- 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.
- pattern - - - String - - - Use the custom_attributes field instead. -
- performance_fabric - - - Int - - - Use the custom_attributes field instead. -
- price - - - ProductPrices - - Indicates the price of an item. - 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.
- purpose - - - Int - - - Use the custom_attributes field instead. -
- 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.
-
-
Arguments
-
-
-
- pageSize - - - Int - -
-

The maximum number of results to return at once. The default is 20.

-
-
-
- currentPage - - - Int - -
-

The page of results to return. The default is 1.

-
-
-
-
- sale - - - Int - - - Use the custom_attributes field instead. -
- short_description - - - ComplexTextValue - - A short description of the product. Its use depends on the theme.
- size - - - Int - - - Use the custom_attributes field instead. -
- sku - - - String - - A number or code assigned to a product to identify the product, options, price, and manufacturer.
- sleeve - - - String - - - Use the custom_attributes field instead. -
- 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. - 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
- strap_bags - - - String - - - Use the custom_attributes field instead. -
- style_bags - - - String - - - Use the custom_attributes field instead. -
- style_bottom - - - String - - - Use the custom_attributes field instead. -
- style_general - - - String - - - Use the custom_attributes field instead. -
- 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. - Use price_tiers for product tier price information. -
- tier_prices - - - [ProductTierPrices] - - An array of ProductTierPrices objects. - Use price_tiers for product tier price information. -
- type_id - - - String - - One of simple, virtual, bundle, downloadable, grouped, or configurable. - Use __typename instead. -
- uid - - - ID! - - The unique ID for a ProductInterface object.
- updated_at - - - String - - Timestamp indicating when the product was updated. - 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 - - - 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. - The field should not be used on the storefront. -
-
-
-
Possible Types
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ProductInterface Types
-

- VirtualProduct -

-
-

- SimpleProduct -

-
-

- DownloadableProduct -

-
-

- BundleProduct -

-
-

- GiftCardProduct -

-
-

- GroupedProduct -

-
-

- ConfigurableProduct -

-
-
-
-
-
-
Example
- - - 
{
-  "activity": "xyz789",
-  "attribute_set_id": 987,
-  "canonical_url": "abc123",
-  "categories": [CategoryInterface],
-  "category_gear": "abc123",
-  "climate": "xyz789",
-  "collar": "xyz789",
-  "color": 123,
-  "country_of_manufacture": "abc123",
-  "created_at": "abc123",
-  "crosssell_products": [ProductInterface],
-  "description": ComplexTextValue,
-  "eco_collection": 987,
-  "erin_recommends": 123,
-  "features_bags": "xyz789",
-  "format": 123,
-  "gender": "xyz789",
-  "gift_message_available": "abc123",
-  "id": 123,
-  "image": ProductImage,
-  "is_returnable": "abc123",
-  "manufacturer": 987,
-  "material": "abc123",
-  "media_gallery": [MediaGalleryInterface],
-  "media_gallery_entries": [MediaGalleryEntry],
-  "meta_description": "xyz789",
-  "meta_keyword": "abc123",
-  "meta_title": "xyz789",
-  "name": "abc123",
-  "new": 987,
-  "new_from_date": "xyz789",
-  "new_to_date": "abc123",
-  "only_x_left_in_stock": 123.45,
-  "options_container": "xyz789",
-  "pattern": "xyz789",
-  "performance_fabric": 987,
-  "price": ProductPrices,
-  "price_range": PriceRange,
-  "price_tiers": [TierPrice],
-  "product_links": [ProductLinksInterface],
-  "purpose": 987,
-  "rating_summary": 987.65,
-  "related_products": [ProductInterface],
-  "review_count": 987,
-  "reviews": ProductReviews,
-  "sale": 987,
-  "short_description": ComplexTextValue,
-  "size": 123,
-  "sku": "xyz789",
-  "sleeve": "xyz789",
-  "small_image": ProductImage,
-  "special_from_date": "abc123",
-  "special_price": 987.65,
-  "special_to_date": "abc123",
-  "staged": true,
-  "stock_status": "IN_STOCK",
-  "strap_bags": "xyz789",
-  "style_bags": "xyz789",
-  "style_bottom": "xyz789",
-  "style_general": "abc123",
-  "swatch_image": "abc123",
-  "thumbnail": ProductImage,
-  "tier_price": 987.65,
-  "tier_prices": [ProductTierPrices],
-  "type_id": "abc123",
-  "uid": "4",
-  "updated_at": "xyz789",
-  "upsell_products": [ProductInterface],
-  "url_key": "abc123",
-  "url_path": "abc123",
-  "url_rewrites": [UrlRewrite],
-  "url_suffix": "xyz789",
-  "websites": [Website]
-}
-
- -
-
-
-
- -
-
- Types -
-

ProductLinksInterface

-
-
-
-
Description
-

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
- - - 
{
-  "link_type": "xyz789",
-  "linked_product_sku": "xyz789",
-  "linked_product_type": "abc123",
-  "position": 123,
-  "sku": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

ProductMediaGalleryEntriesContent

-
-
-
-
Description
-

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

ProductMediaGalleryEntriesVideoContent

-
-
-
-
Description
-

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
- - - 
{
-  "media_type": "abc123",
-  "video_description": "xyz789",
-  "video_metadata": "xyz789",
-  "video_provider": "abc123",
-  "video_title": "xyz789",
-  "video_url": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

ProductPrice

-
-
-
-
Description
-

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
- - - 
{
-  "discount": ProductDiscount,
-  "final_price": Money,
-  "fixed_product_taxes": [FixedProductTax],
-  "regular_price": Money
-}
-
- -
-
-
-
-
-
- Types -
-

ProductPrices

-
-
-
-
Description
-

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. - 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. - Use PriceRange.minimum_price instead. -
- regularPrice - - - Price - - The base price of a product. - Use regular_price from PriceRange.minimum_price or PriceRange.maximum_price instead. -
-
-
-
-
-
Example
- - - 
{
-  "maximalPrice": Price,
-  "minimalPrice": Price,
-  "regularPrice": Price
-}
-
- -
-
-
-
-
-
- Types -
-

ProductReview

-
-
-
-
Description
-

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
- - - 
{
-  "average_rating": 987.65,
-  "created_at": "xyz789",
-  "nickname": "abc123",
-  "product": ProductInterface,
-  "ratings_breakdown": [ProductReviewRating],
-  "summary": "xyz789",
-  "text": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

ProductReviewRating

-
-
-
-
Description
-

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
- - - 
{
-  "name": "abc123",
-  "value": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

ProductReviewRatingInput

-
-
-
-
Description
-

Contains the reviewer's rating for a single aspect of a review.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Input FieldDescription
- id - - - String! - - -

An encoded rating ID.

-
- value_id - - - String! - - -

An encoded rating value ID.

-
-
-
-
-
-
Example
- - - 
{
-  "id": "xyz789",
-  "value_id": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

ProductReviewRatingMetadata

-
-
-
-
Description
-

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
- - - 
{
-  "id": "abc123",
-  "name": "xyz789",
-  "values": [ProductReviewRatingValueMetadata]
-}
-
- -
-
-
-
-
-
- Types -
-

ProductReviewRatingValueMetadata

-
-
-
-
Description
-

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
- - - 
{
-  "value": "abc123",
-  "value_id": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

ProductReviewRatingsMetadata

-
-
-
-
Description
-

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
- - - 
{"items": [ProductReviewRatingMetadata]}
-
- -
-
-
-
-
-
- Types -
-

ProductReviews

-
-
-
-
Description
-

Contains an array of product reviews.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- items - - - [ProductReview]! - - An array of product reviews.
- page_info - - - SearchResultPageInfo! - - Metadata for pagination rendering.
-
-
-
-
-
Example
- - - 
{
-  "items": [ProductReview],
-  "page_info": SearchResultPageInfo
-}
-
- -
-
-
-
-
-
- Types -
-

ProductStockStatus

-
-
-
-
Description
-

This enumeration states whether a product stock status is in stock or out of stock

-
-
-
Values
- - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

IN_STOCK

-
-

OUT_OF_STOCK

-
-
-
-
-
-
Example
- - - 
"IN_STOCK"
-
- -
-
-
-
-
-
- Types -
-

ProductTierPrices

-
-
-
-
Description
-

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. - Not relevant for the storefront. -
- percentage_value - - - Float - - The percentage discount of the item. - Use TierPrice.discount instead. -
- qty - - - Float - - The number of items that must be purchased to qualify for tier pricing. - Use TierPrice.quantity instead. -
- value - - - Float - - The price of the fixed price item. - Use TierPrice.final_price instead. -
- website_id - - - Float - - The ID assigned to the website. - Not relevant for the storefront. -
-
-
-
-
-
Example
- - - 
{
-  "customer_group_id": "abc123",
-  "percentage_value": 123.45,
-  "qty": 987.65,
-  "value": 987.65,
-  "website_id": 987.65
-}
-
- -
-
-
-
-
-
- Types -
-

ProductVideo

-
-
-
-
Description
-

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.
- url - - - String - - The URL of the product image or video.
- video_content - - - ProductMediaGalleryEntriesVideoContent - - Contains a ProductMediaGalleryEntriesVideoContent object.
-
-
-
-
-
Example
- - - 
{
-  "disabled": false,
-  "label": "abc123",
-  "position": 123,
-  "url": "xyz789",
-  "video_content": ProductMediaGalleryEntriesVideoContent
-}
-
- -
-
-
-
-
-
- Types -
-

Products

-
-
-
-
Description
-

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.
-
-
Arguments
-
-
-
- filter - - - AggregationsFilterInput - -
-
-
-
-
- filters - - - [LayerFilter] - - Layered navigation filters array. - 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
- - - 
{
-  "aggregations": [Aggregation],
-  "filters": [LayerFilter],
-  "items": [ProductInterface],
-  "page_info": SearchResultPageInfo,
-  "sort_fields": SortFields,
-  "suggestions": [SearchSuggestion],
-  "total_count": 987
-}
-
- -
-
-
-
-
-
- Types -
-

PurchaseOrder

-
-
-
-
Description
-

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
- - - 
{
-  "approval_flow": [PurchaseOrderRuleApprovalFlow],
-  "available_actions": ["REJECT"],
-  "comments": [PurchaseOrderComment],
-  "created_at": "abc123",
-  "created_by": Customer,
-  "history_log": [PurchaseOrderHistoryItem],
-  "number": "abc123",
-  "order": CustomerOrder,
-  "quote": Cart,
-  "status": "PENDING",
-  "uid": "4",
-  "updated_at": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

PurchaseOrderAction

-
-
-
-
Values
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

REJECT

-
-

CANCEL

-
-

VALIDATE

-
-

APPROVE

-
-

PLACE_ORDER

-
-
-
-
-
-
Example
- - - 
"REJECT"
-
- -
-
-
-
-
-
- Types -
-

PurchaseOrderActionError

-
-
-
-
Description
-

Contains details about a failed action.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- message - - - String! - - The returned error message.
- type - - - PurchaseOrderErrorType! - - The error type.
-
-
-
-
-
Example
- - - 
{"message": "abc123", "type": "NOT_FOUND"}
-
- -
-
-
-
-
-
- Types -
-

PurchaseOrderApprovalFlowEvent

-
-
-
-
Description
-

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
- - - 
{
-  "message": "xyz789",
-  "name": "xyz789",
-  "role": "abc123",
-  "status": "PENDING",
-  "updated_at": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

PurchaseOrderApprovalFlowItemStatus

-
-
-
-
Values
- - - - - - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

PENDING

-
-

APPROVED

-
-

REJECTED

-
-
-
-
-
-
Example
- - - 
"PENDING"
-
- -
-
-
-
-
-
- Types -
-

PurchaseOrderApprovalRule

-
-
-
-
Description
-

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
- - - 
{
-  "applies_to_roles": [CompanyRole],
-  "approver_roles": [CompanyRole],
-  "condition": PurchaseOrderApprovalRuleConditionInterface,
-  "created_at": "xyz789",
-  "created_by": "xyz789",
-  "description": "xyz789",
-  "name": "abc123",
-  "status": "ENABLED",
-  "uid": 4,
-  "updated_at": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

PurchaseOrderApprovalRuleConditionAmount

-
-
-
-
Description
-

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
- - - 
{
-  "amount": Money,
-  "attribute": "GRAND_TOTAL",
-  "operator": "MORE_THAN"
-}
-
- -
-
-
-
-
-
- Types -
-

PurchaseOrderApprovalRuleConditionInterface

-
-
-
-
Description
-

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
- - - 
{"attribute": "GRAND_TOTAL", "operator": "MORE_THAN"}
-
- -
-
-
-
-
-
- Types -
-

PurchaseOrderApprovalRuleConditionOperator

-
-
-
-
Values
- - - - - - - - - - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

MORE_THAN

-
-

LESS_THAN

-
-

MORE_THAN_OR_EQUAL_TO

-
-

LESS_THAN_OR_EQUAL_TO

-
-
-
-
-
-
Example
- - - 
"MORE_THAN"
-
- -
-
-
-
-
-
- Types -
-

PurchaseOrderApprovalRuleConditionQuantity

-
-
-
-
Description
-

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
- - - 
{"attribute": "GRAND_TOTAL", "operator": "MORE_THAN", "quantity": 987}
-
- -
-
-
-
-
-
- Types -
-

PurchaseOrderApprovalRuleInput

-
-
-
-
Description
-

Defines a new purchase order approval rule.

-
-
-
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
- - - 
{
-  "applies_to": ["4"],
-  "approvers": [4],
-  "condition": CreatePurchaseOrderApprovalRuleConditionInput,
-  "description": "xyz789",
-  "name": "xyz789",
-  "status": "ENABLED"
-}
-
- -
-
-
-
-
-
- Types -
-

PurchaseOrderApprovalRuleMetadata

-
-
-
-
Description
-

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
- - - 
{
-  "available_applies_to": [CompanyRole],
-  "available_condition_currencies": [AvailableCurrency],
-  "available_requires_approval_from": [CompanyRole]
-}
-
- -
-
-
-
-
-
- Types -
-

PurchaseOrderApprovalRuleStatus

-
-
-
-
Values
- - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

ENABLED

-
-

DISABLED

-
-
-
-
-
-
Example
- - - 
"ENABLED"
-
- -
-
-
-
-
-
- Types -
-

PurchaseOrderApprovalRuleType

-
-
-
-
Values
- - - - - - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

GRAND_TOTAL

-
-

SHIPPING_INCL_TAX

-
-

NUMBER_OF_SKUS

-
-
-
-
-
-
Example
- - - 
"GRAND_TOTAL"
-
- -
-
-
-
-
-
- Types -
-

PurchaseOrderApprovalRules

-
-
-
-
Description
-

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
- - - 
{
-  "items": [PurchaseOrderApprovalRule],
-  "page_info": SearchResultPageInfo,
-  "total_count": 123
-}
-
- -
-
-
-
-
-
- Types -
-

PurchaseOrderComment

-
-
-
-
Description
-

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
- - - 
{
-  "author": Customer,
-  "created_at": "xyz789",
-  "text": "xyz789",
-  "uid": 4
-}
-
- -
-
-
-
-
-
- Types -
-

PurchaseOrderErrorType

-
-
-
-
Values
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

NOT_FOUND

-
-

OPERATION_NOT_APPLICABLE

-
-

COULD_NOT_SAVE

-
-

NOT_VALID_DATA

-
-

UNDEFINED

-
-
-
-
-
-
Example
- - - 
"NOT_FOUND"
-
- -
-
-
-
-
-
- Types -
-

PurchaseOrderHistoryItem

-
-
-
-
Description
-

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
- - - 
{
-  "activity": "abc123",
-  "created_at": "xyz789",
-  "message": "xyz789",
-  "uid": 4
-}
-
- -
-
-
-
-
-
- Types -
-

PurchaseOrderRuleApprovalFlow

-
-
-
-
Description
-

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
- - - 
{
-  "events": [PurchaseOrderApprovalFlowEvent],
-  "rule_name": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

PurchaseOrderStatus

-
-
-
-
Values
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

PENDING

-
-

APPROVAL_REQUIRED

-
-

APPROVED

-
-

ORDER_IN_PROGRESS

-
-

ORDER_PLACED

-
-

ORDER_FAILED

-
-

REJECTED

-
-

CANCELED

-
-

APPROVED_PENDING_PAYMENT

-
-
-
-
-
-
Example
- - - 
"PENDING"
-
- -
-
-
-
-
-
- Types -
-

PurchaseOrders

-
-
-
-
Description
-

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
- - - 
{
-  "items": [PurchaseOrder],
-  "page_info": SearchResultPageInfo,
-  "total_count": 987
-}
-
- -
-
-
-
-
-
- Types -
-

PurchaseOrdersActionInput

-
-
-
-
Description
-

Defines which purchase orders to act on.

-
-
-
Fields
- - - - - - - - - - - - - -
Input FieldDescription
- purchase_order_uids - - - [ID]! - - -

An array of of purchase order UIDs.

-
-
-
-
-
-
Example
- - - 
{"purchase_order_uids": ["4"]}
-
- -
-
-
-
-
-
- Types -
-

PurchaseOrdersActionOutput

-
-
-
-
Description
-

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
- - - 
{
-  "errors": [PurchaseOrderActionError],
-  "purchase_orders": [PurchaseOrder]
-}
-
- -
-
-
-
-
-
- Types -
-

PurchaseOrdersFilterInput

-
-
-
-
Description
-

Defines the criteria to use to filter the list of purchase orders.

-
-
-
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
- - - 
{
-  "company_purchase_orders": true,
-  "created_date": FilterRangeTypeInput,
-  "require_my_approval": true,
-  "status": "PENDING"
-}
-
- -
-
-
-
-
-
- Types -
-

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
- - - 
{
-  "code": "xyz789",
-  "id": 123,
-  "name": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

RemoveCouponFromCartInput

-
-
-
-
Description
-

Specifies the cart from which to remove a coupon.

-
-
-
Fields
- - - - - - - - - - - - - -
Input FieldDescription
- cart_id - - - String! - - -

The unique ID of a Cart object.

-
-
-
-
-
-
Example
- - - 
{"cart_id": "xyz789"}
-
- -
-
-
-
-
-
- Types -
-

RemoveCouponFromCartOutput

-
-
-
-
Description
-

Contains details about the cart after removing a coupon.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- cart - - - Cart - - The cart after removing a coupon.
-
-
-
-
-
Example
- - - 
{"cart": Cart}
-
- -
-
-
-
-
-
- Types -
-

RemoveGiftCardFromCartInput

-
-
-
-
Description
-

Defines the input required to run the removeGiftCardFromCart mutation.

-
-
-
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
- - - 
{
-  "cart_id": "xyz789",
-  "gift_card_code": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

RemoveGiftCardFromCartOutput

-
-
-
-
Description
-

Defines the possible output for the removeGiftCardFromCart mutation.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- cart - - - Cart! - - The contents of the specified shopping cart.
-
-
-
-
-
Example
- - - 
{"cart": Cart}
-
- -
-
-
-
-
-
- Types -
-

RemoveGiftRegistryItemsOutput

-
-
-
-
Description
-

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
- - - 
{"gift_registry": GiftRegistry}
-
- -
-
-
-
-
-
- Types -
-

RemoveGiftRegistryOutput

-
-
-
-
Description
-

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
- - - 
{"success": false}
-
- -
-
-
-
-
-
- Types -
-

RemoveGiftRegistryRegistrantsOutput

-
-
-
-
Description
-

Contains the results of a request to delete a registrant.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- gift_registry - - - GiftRegistry - - The gift registry after deleting registrants.
-
-
-
-
-
Example
- - - 
{"gift_registry": GiftRegistry}
-
- -
-
-
-
-
-
- Types -
-

RemoveItemFromCartInput

-
-
-
-
Description
-

Specifies which items to remove from the cart.

-
-
-
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
- - - 
{
-  "cart_id": "xyz789",
-  "cart_item_id": 987,
-  "cart_item_uid": 4
-}
-
- -
-
-
-
-
-
- Types -
-

RemoveItemFromCartOutput

-
-
-
-
Description
-

Contains details about the cart after removing an item.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- cart - - - Cart! - - The cart after removing an item.
-
-
-
-
-
Example
- - - 
{"cart": Cart}
-
- -
-
-
-
-
-
- Types -
-

RemoveNegotiableQuoteItemsInput

-
-
-
-
Description
-

Defines the items to remove from the specified negotiable quote.

-
-
-
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
- - - 
{
-  "quote_item_uids": ["4"],
-  "quote_uid": "4"
-}
-
- -
-
-
-
-
-
- Types -
-

RemoveNegotiableQuoteItemsOutput

-
-
-
-
Description
-

Contains the negotiable quote.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- quote - - - NegotiableQuote - - The negotiable quote after removing items.
-
-
-
-
-
Example
- - - 
{"quote": NegotiableQuote}
-
- -
-
-
-
-
-
- Types -
-

RemoveProductsFromCompareListInput

-
-
-
-
Description
-

Defines which products to remove from a compare list.

-
-
-
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
- - - 
{"products": [4], "uid": 4}
-
- -
-
-
-
-
-
- Types -
-

RemoveProductsFromWishlistOutput

-
-
-
-
Description
-

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
- - - 
{
-  "user_errors": [WishListUserInputError],
-  "wishlist": Wishlist
-}
-
- -
-
-
-
-
-
- Types -
-

RemoveReturnTrackingInput

-
-
-
-
Description
-

Defines the tracking information to delete.

-
-
-
Fields
- - - - - - - - - - - - - -
Input FieldDescription
- return_shipping_tracking_uid - - - ID! - - -

The unique ID for a ReturnShippingTracking object.

-
-
-
-
-
-
Example
- - - 
{"return_shipping_tracking_uid": "4"}
-
- -
-
-
-
-
-
- Types -
-

RemoveReturnTrackingOutput

-
-
-
-
Description
-

Contains the response after deleting tracking information.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- return - - - Return - - Contains details about the modified return.
-
-
-
-
-
Example
- - - 
{"return": Return}
-
- -
-
-
-
-
-
- Types -
-

RemoveRewardPointsFromCartOutput

-
-
-
-
Description
-

Contains the customer cart.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- cart - - - Cart! - - The customer cart after reward points are removed.
-
-
-
-
-
Example
- - - 
{"cart": Cart}
-
- -
-
-
-
-
-
- Types -
-

RemoveStoreCreditFromCartInput

-
-
-
-
Description
-

Defines the input required to run the removeStoreCreditFromCart mutation.

-
-
-
Fields
- - - - - - - - - - - - - -
Input FieldDescription
- cart_id - - - String! - - -

The unique ID that identifies the customer's cart.

-
-
-
-
-
-
Example
- - - 
{"cart_id": "xyz789"}
-
- -
-
-
-
-
-
- Types -
-

RemoveStoreCreditFromCartOutput

-
-
-
-
Description
-

Defines the possible output for the removeStoreCreditFromCart mutation.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- cart - - - Cart! - - The contents of the specified shopping cart.
-
-
-
-
-
Example
- - - 
{"cart": Cart}
-
- -
-
-
-
-
-
- Types -
-

ReorderItemsOutput

-
-
-
-
Description
-

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
- - - 
{
-  "cart": Cart,
-  "userInputErrors": [CheckoutUserInputError]
-}
-
- -
-
-
-
-
-
- Types -
-

RequestNegotiableQuoteInput

-
-
-
-
Description
-

Defines properties of a negotiable quote request.

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

-
- quote_name - - - String! - - -

The name the buyer assigned to the negotiable quote request.

-
-
-
-
-
-
Example
- - - 
{
-  "cart_id": "4",
-  "comment": NegotiableQuoteCommentInput,
-  "quote_name": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

RequestNegotiableQuoteOutput

-
-
-
-
Description
-

Contains the NegotiableQuote object generated when a buyer requests a negotiable quote.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- quote - - - NegotiableQuote - - Details about the negotiable quote.
-
-
-
-
-
Example
- - - 
{"quote": NegotiableQuote}
-
- -
-
-
-
-
-
- Types -
-

RequestReturnInput

-
-
-
-
Description
-

Contains information needed to start a return request.

-
-
-
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
- - - 
{
-  "comment_text": "abc123",
-  "contact_email": "abc123",
-  "items": [RequestReturnItemInput],
-  "order_uid": 4
-}
-
- -
-
-
-
-
-
- Types -
-

RequestReturnItemInput

-
-
-
-
Description
-

Contains details about an item to be returned.

-
-
-
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
- - - 
{
-  "entered_custom_attributes": [
-    EnteredCustomAttributeInput
-  ],
-  "order_item_uid": 4,
-  "quantity_to_return": 987.65,
-  "selected_custom_attributes": [
-    SelectedCustomAttributeInput
-  ]
-}
-
- -
-
-
-
-
-
- Types -
-

RequestReturnOutput

-
-
-
-
Description
-

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.
-
-
Arguments
-
-
-
- pageSize - - - Int - -
-

Specifies the maximum number of results to return at once. The default is 20.

-
-
-
- currentPage - - - Int - -
-

Specifies which page of results to return. The default is 1.

-
-
-
-
-
-
-
-
-
Example
- - - 
{
-  "return": Return,
-  "returns": Returns
-}
-
- -
-
-
-
-
-
- Types -
-

RequisitionList

-
-
-
-
Description
-

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.
-
-
Arguments
-
-
-
- currentPage - - - Int - -
-

The page of results to return. The default value is 1.

-
-
-
- pageSize - - - Int - -
-

The maximum number of results to return. The default value is 1.

-
-
-
-
- items_count - - - Int! - - The number of items in the list.
- name - - - String! - - The requisition list name.
- uid - - - ID! - - The unique requisition list ID.
- updated_at - - - String - - The time of the last modification of the requisition list.
-
-
-
-
-
Example
- - - 
{
-  "description": "abc123",
-  "items": RequistionListItems,
-  "items_count": 987,
-  "name": "abc123",
-  "uid": 4,
-  "updated_at": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

RequisitionListFilterInput

-
-
-
-
Description
-

Defines requisition list filters.

-
-
-
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
- - - 
{
-  "name": FilterMatchTypeInput,
-  "uids": FilterEqualTypeInput
-}
-
- -
-
-
-
-
-
- Types -
-

RequisitionListItemInterface

-
-
-
-
Description
-

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
- - - 
{
-  "customizable_options": [SelectedCustomizableOption],
-  "product": ProductInterface,
-  "quantity": 123.45,
-  "uid": 4
-}
-
- -
-
-
-
-
-
- Types -
-

RequisitionListItemsInput

-
-
-
-
Description
-

Defines the items to add.

-
-
-
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
- - - 
{
-  "entered_options": [EnteredOptionInput],
-  "parent_sku": "xyz789",
-  "quantity": 123.45,
-  "selected_options": ["abc123"],
-  "sku": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

RequisitionLists

-
-
-
-
Description
-

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
- - - 
{
-  "items": [RequisitionList],
-  "page_info": SearchResultPageInfo,
-  "total_count": 123
-}
-
- -
-
-
-
-
-
- Types -
-

RequistionListItems

-
-
-
-
Description
-

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
- - - 
{
-  "items": [RequisitionListItemInterface],
-  "page_info": SearchResultPageInfo,
-  "total_pages": 123
-}
-
- -
-
-
-
-
-
- Types -
-

Return

-
-
-
-
Description
-

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
- - - 
{
-  "available_shipping_carriers": [ReturnShippingCarrier],
-  "comments": [ReturnComment],
-  "created_at": "abc123",
-  "customer": ReturnCustomer,
-  "items": [ReturnItem],
-  "number": "xyz789",
-  "order": CustomerOrder,
-  "shipping": ReturnShipping,
-  "status": "PENDING",
-  "uid": "4"
-}
-
- -
-
-
-
-
-
- Types -
-

ReturnComment

-
-
-
-
Description
-

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
- - - 
{
-  "author_name": "abc123",
-  "created_at": "abc123",
-  "text": "abc123",
-  "uid": "4"
-}
-
- -
-
-
-
-
-
- Types -
-

ReturnCustomAttribute

-
-
-
-
Description
-

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
- - - 
{
-  "label": "abc123",
-  "uid": 4,
-  "value": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

ReturnCustomer

-
-
-
-
Description
-

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
- - - 
{
-  "email": "abc123",
-  "firstname": "xyz789",
-  "lastname": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

ReturnItem

-
-
-
-
Description
-

Contains details about a product being returned.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- custom_attributes - - - [ReturnCustomAttribute] - - Return item 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
- - - 
{
-  "custom_attributes": [ReturnCustomAttribute],
-  "order_item": OrderItemInterface,
-  "quantity": 987.65,
-  "request_quantity": 987.65,
-  "status": "PENDING",
-  "uid": "4"
-}
-
- -
-
-
-
-
-
- Types -
-

ReturnItemStatus

-
-
-
-
Values
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

PENDING

-
-

AUTHORIZED

-
-

RECEIVED

-
-

APPROVED

-
-

REJECTED

-
-

DENIED

-
-
-
-
-
-
Example
- - - 
"PENDING"
-
- -
-
-
-
-
-
- Types -
-

ReturnShipping

-
-
-
-
Description
-

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.
-
-
Arguments
-
-
-
- uid - - - ID - -
-
-
-
-
-
-
-
-
-
Example
- - - 
{
-  "address": ReturnShippingAddress,
-  "tracking": [ReturnShippingTracking]
-}
-
- -
-
-
-
-
-
- Types -
-

ReturnShippingAddress

-
-
-
-
Description
-

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
- - - 
{
-  "city": "abc123",
-  "contact_name": "xyz789",
-  "country": Country,
-  "postcode": "abc123",
-  "region": Region,
-  "street": ["xyz789"],
-  "telephone": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

ReturnShippingCarrier

-
-
-
-
Description
-

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
- - - 
{
-  "label": "xyz789",
-  "uid": "4"
-}
-
- -
-
-
-
-
-
- Types -
-

ReturnShippingTracking

-
-
-
-
Description
-

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
- - - 
{
-  "carrier": ReturnShippingCarrier,
-  "status": ReturnShippingTrackingStatus,
-  "tracking_number": "xyz789",
-  "uid": "4"
-}
-
- -
-
-
-
-
-
- Types -
-

ReturnShippingTrackingStatus

-
-
-
-
Description
-

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
- - - 
{"text": "xyz789", "type": "INFORMATION"}
-
- -
-
-
-
-
-
- Types -
-

ReturnShippingTrackingStatusType

-
-
-
-
Values
- - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

INFORMATION

-
-

ERROR

-
-
-
-
-
-
Example
- - - 
"INFORMATION"
-
- -
-
-
-
-
-
- Types -
-

ReturnStatus

-
-
-
-
Values
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

PENDING

-
-

AUTHORIZED

-
-

PARTIALLY_AUTHORIZED

-
-

RECEIVED

-
-

PARTIALLY_RECEIVED

-
-

APPROVED

-
-

PARTIALLY_APPROVED

-
-

REJECTED

-
-

PARTIALLY_REJECTED

-
-

DENIED

-
-

PROCESSED_AND_CLOSED

-
-

CLOSED

-
-
-
-
-
-
Example
- - - 
"PENDING"
-
- -
-
-
-
-
-
- Types -
-

Returns

-
-
-
-
Description
-

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
- - - 
{
-  "items": [Return],
-  "page_info": SearchResultPageInfo,
-  "total_count": 123
-}
-
- -
-
-
-
-
-
- Types -
-

RevokeCustomerTokenOutput

-
-
-
-
Description
-

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

RewardPoints

-
-
-
-
Description
-

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
- - - 
{
-  "balance": RewardPointsAmount,
-  "balance_history": [RewardPointsBalanceHistoryItem],
-  "exchange_rates": RewardPointsExchangeRates,
-  "subscription_status": RewardPointsSubscriptionStatus
-}
-
- -
-
-
-
-
-
- Types -
-

RewardPointsAmount

-
-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- money - - - Money! - - The reward points amount in store currency.
- points - - - Float! - - The reward points amount in points.
-
-
-
-
-
Example
- - - 
{"money": Money, "points": 123.45}
-
- -
-
-
-
-
-
- Types -
-

RewardPointsBalanceHistoryItem

-
-
-
-
Description
-

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
- - - 
{
-  "balance": RewardPointsAmount,
-  "change_reason": "abc123",
-  "date": "xyz789",
-  "points_change": 987.65
-}
-
- -
-
-
-
-
-
- Types -
-

RewardPointsExchangeRates

-
-
-
-
Description
-

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
- - - 
{
-  "earning": RewardPointsRate,
-  "redemption": RewardPointsRate
-}
-
- -
-
-
-
-
-
- Types -
-

RewardPointsRate

-
-
-
-
Description
-

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
- - - 
{"currency_amount": 987.65, "points": 123.45}
-
- -
-
-
-
-
-
- Types -
-

RewardPointsSubscriptionStatus

-
-
-
-
Description
-

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
- - - 
{
-  "balance_updates": "SUBSCRIBED",
-  "points_expiration_notifications": "SUBSCRIBED"
-}
-
- -
-
-
-
-
-
- Types -
-

RewardPointsSubscriptionStatusesEnum

-
-
-
-
Values
- - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

SUBSCRIBED

-
-

NOT_SUBSCRIBED

-
-
-
-
-
-
Example
- - - 
"SUBSCRIBED"
-
- -
-
-
-
-
-
- Types -
-

RoutableInterface

-
-
-
-
Description
-

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 -

-
-

- DownloadableProduct -

-
-

- BundleProduct -

-
-

- GiftCardProduct -

-
-

- GroupedProduct -

-
-

- ConfigurableProduct -

-
-
-
-
-
-
Example
- - - 
{
-  "redirect_code": 123,
-  "relative_url": "abc123",
-  "type": "CMS_PAGE"
-}
-
- -
-
-
-
-
-
- Types -
-

SalesCommentItem

-
-
-
-
Description
-

Contains details about a comment.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- message - - - String! - - The text of the message.
- timestamp - - - String! - - The timestamp of the comment.
-
-
-
-
-
Example
- - - 
{
-  "message": "xyz789",
-  "timestamp": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

ScopeTypeEnum

-
-
-
-
Description
-

This enumeration defines the scope type for customer orders.

-
-
-
Values
- - - - - - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

GLOBAL

-
-

WEBSITE

-
-

STORE

-
-
-
-
-
-
Example
- - - 
"GLOBAL"
-
- -
-
-
-
-
-
- Types -
-

SearchResultPageInfo

-
-
-
-
Description
-

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
- - - 
{"current_page": 123, "page_size": 123, "total_pages": 123}
-
- -
-
-
-
-
-
- Types -
-

SearchSuggestion

-
-
-
-
Description
-

A string that contains search suggestion

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- search - - - String! - - The search suggestion of existing product.
-
-
-
-
-
Example
- - - 
{"search": "abc123"}
-
- -
-
-
-
-
-
- Types -
-

SelectedBundleOption

-
-
-
-
Description
-

Contains details about a selected bundle option.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- id - - - Int! - - - 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
- - - 
{
-  "id": 123,
-  "label": "abc123",
-  "type": "xyz789",
-  "uid": 4,
-  "values": [SelectedBundleOptionValue]
-}
-
- -
-
-
-
-
-
- Types -
-

SelectedBundleOptionValue

-
-
-
-
Description
-

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.
- price - - - Float! - - 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
- - - 
{
-  "id": 987,
-  "label": "abc123",
-  "price": 987.65,
-  "quantity": 123.45,
-  "uid": "4"
-}
-
- -
-
-
-
-
-
- Types -
-

SelectedConfigurableOption

-
-
-
-
Description
-

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! - - - Use SelectedConfigurableOption.configurable_product_option_uid instead. -
- option_label - - - String! - - The display text for the option.
- value_id - - - Int! - - - Use SelectedConfigurableOption.configurable_product_option_value_uid instead. -
- value_label - - - String! - - The display name of the selected configurable option.
-
-
-
-
-
Example
- - - 
{
-  "configurable_product_option_uid": "4",
-  "configurable_product_option_value_uid": 4,
-  "id": 123,
-  "option_label": "abc123",
-  "value_id": 987,
-  "value_label": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

SelectedCustomAttributeInput

-
-
-
-
Description
-

Contains details about an attribute the buyer selected.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Input FieldDescription
- attribute_code - - - String! - - -

A string that identifies the selected attribute.

-
- value - - - ID! - - -

The unique ID for a CustomAttribute object of a selected custom attribute.

-
-
-
-
-
-
Example
- - - 
{"attribute_code": "xyz789", "value": 4}
-
- -
-
-
-
-
-
- Types -
-

SelectedCustomizableOption

-
-
-
-
Description
-

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! - - - 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
- - - 
{
-  "customizable_option_uid": "4",
-  "id": 123,
-  "is_required": false,
-  "label": "abc123",
-  "sort_order": 123,
-  "type": "abc123",
-  "values": [SelectedCustomizableOptionValue]
-}
-
- -
-
-
-
-
-
- Types -
-

SelectedCustomizableOptionValue

-
-
-
-
Description
-

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! - - - 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
- - - 
{
-  "customizable_option_value_uid": "4",
-  "id": 987,
-  "label": "xyz789",
-  "price": CartItemSelectedOptionValuePrice,
-  "value": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

SelectedPaymentMethod

-
-
-
-
Description
-

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
- - - 
{
-  "code": "abc123",
-  "purchase_order_number": "abc123",
-  "title": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

SelectedShippingMethod

-
-
-
-
Description
-

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 - - - 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
- - - 
{
-  "amount": Money,
-  "base_amount": Money,
-  "carrier_code": "abc123",
-  "carrier_title": "xyz789",
-  "method_code": "xyz789",
-  "method_title": "abc123",
-  "price_excl_tax": Money,
-  "price_incl_tax": Money
-}
-
- -
-
-
-
-
-
- Types -
-

SendEmailToFriendInput

-
-
-
-
Description
-

Defines the referenced product and the email sender and recipients.

-
-
-
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
- - - 
{
-  "product_id": 123,
-  "recipients": [SendEmailToFriendRecipientInput],
-  "sender": SendEmailToFriendSenderInput
-}
-
- -
-
-
-
-
-
- Types -
-

SendEmailToFriendOutput

-
-
-
-
Description
-

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
- - - 
{
-  "recipients": [SendEmailToFriendRecipient],
-  "sender": SendEmailToFriendSender
-}
-
- -
-
-
-
-
-
- Types -
-

SendEmailToFriendRecipient

-
-
-
-
Description
-

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
- - - 
{
-  "email": "xyz789",
-  "name": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

SendEmailToFriendRecipientInput

-
-
-
-
Description
-

Contains details about a recipient.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Input FieldDescription
- email - - - String! - - -

The email address of the recipient.

-
- name - - - String! - - -

The name of the recipient.

-
-
-
-
-
-
Example
- - - 
{
-  "email": "xyz789",
-  "name": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

SendEmailToFriendSender

-
-
-
-
Description
-

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
- - - 
{
-  "email": "xyz789",
-  "message": "xyz789",
-  "name": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

SendEmailToFriendSenderInput

-
-
-
-
Description
-

Contains details about the sender.

-
-
-
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
- - - 
{
-  "email": "xyz789",
-  "message": "abc123",
-  "name": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

SendFriendConfiguration

-
-
-
-
Description
-

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
- - - 
{"enabled_for_customers": true, "enabled_for_guests": false}
-
- -
-
-
-
-
-
- Types -
-

SendNegotiableQuoteForReviewInput

-
-
-
-
Description
-

Specifies which negotiable quote to send for review.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Input FieldDescription
- comment - - - NegotiableQuoteCommentInput - - -

A comment for the seller to review.

-
- quote_uid - - - ID! - - -

The unique ID of a NegotiableQuote object.

-
-
-
-
-
-
Example
- - - 
{
-  "comment": NegotiableQuoteCommentInput,
-  "quote_uid": "4"
-}
-
- -
-
-
-
-
-
- Types -
-

SendNegotiableQuoteForReviewOutput

-
-
-
-
Description
-

Contains the negotiable quote.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- quote - - - NegotiableQuote - - The negotiable quote after sending for seller review.
-
-
-
-
-
Example
- - - 
{"quote": NegotiableQuote}
-
- -
-
-
-
-
-
- Types -
-

SetBillingAddressOnCartInput

-
-
-
-
Description
-

Sets the billing address.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Input FieldDescription
- billing_address - - - BillingAddressInput! - - -

The billing address.

-
- cart_id - - - String! - - -

The unique ID of a Cart object.

-
-
-
-
-
-
Example
- - - 
{
-  "billing_address": BillingAddressInput,
-  "cart_id": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

SetBillingAddressOnCartOutput

-
-
-
-
Description
-

Contains details about the cart after setting the billing address.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- cart - - - Cart! - - The cart after setting the billing address.
-
-
-
-
-
Example
- - - 
{"cart": Cart}
-
- -
-
-
-
-
-
- Types -
-

SetGiftOptionsOnCartInput

-
-
-
-
Description
-

Defines the gift options applied to the cart.

-
-
-
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
- - - 
{
-  "cart_id": "abc123",
-  "gift_message": GiftMessageInput,
-  "gift_receipt_included": false,
-  "gift_wrapping_id": 4,
-  "printed_card_included": true
-}
-
- -
-
-
-
-
-
- Types -
-

SetGiftOptionsOnCartOutput

-
-
-
-
Description
-

Contains the cart after gift options have been applied.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- cart - - - Cart! - - The modified cart object.
-
-
-
-
-
Example
- - - 
{"cart": Cart}
-
- -
-
-
-
-
-
- Types -
-

SetGuestEmailOnCartInput

-
-
-
-
Description
-

Defines the guest email and cart.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Input FieldDescription
- cart_id - - - String! - - -

The unique ID of a Cart object.

-
- email - - - String! - - -

The email address of the guest.

-
-
-
-
-
-
Example
- - - 
{
-  "cart_id": "abc123",
-  "email": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

SetGuestEmailOnCartOutput

-
-
-
-
Description
-

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
- - - 
{"cart": Cart}
-
- -
-
-
-
-
-
- Types -
-

SetNegotiableQuoteBillingAddressInput

-
-
-
-
Description
-

Sets the billing address.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Input FieldDescription
- billing_address - - - NegotiableQuoteBillingAddressInput! - - -

The billing address to be added.

-
- quote_uid - - - ID! - - -

The unique ID of a NegotiableQuote object.

-
-
-
-
-
-
Example
- - - 
{
-  "billing_address": NegotiableQuoteBillingAddressInput,
-  "quote_uid": "4"
-}
-
- -
-
-
-
-
-
- Types -
-

SetNegotiableQuoteBillingAddressOutput

-
-
-
-
Description
-

Contains the negotiable quote.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- quote - - - NegotiableQuote - - The negotiable quote after assigning a billing address.
-
-
-
-
-
Example
- - - 
{"quote": NegotiableQuote}
-
- -
-
-
-
-
-
- Types -
-

SetNegotiableQuotePaymentMethodInput

-
-
-
-
Description
-

Defines the payment method of the specified negotiable quote.

-
-
-
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
- - - 
{
-  "payment_method": NegotiableQuotePaymentMethodInput,
-  "quote_uid": "4"
-}
-
- -
-
-
-
-
-
- Types -
-

SetNegotiableQuotePaymentMethodOutput

-
-
-
-
Description
-

Contains details about the negotiable quote after setting the payment method.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- quote - - - NegotiableQuote - - The updated negotiable quote.
-
-
-
-
-
Example
- - - 
{"quote": NegotiableQuote}
-
- -
-
-
-
-
-
- Types -
-

SetNegotiableQuoteShippingAddressInput

-
-
-
-
Description
-

Defines the shipping address to assign to the negotiable quote.

-
-
-
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
- - - 
{
-  "customer_address_id": 4,
-  "quote_uid": 4,
-  "shipping_addresses": [
-    NegotiableQuoteShippingAddressInput
-  ]
-}
-
- -
-
-
-
-
-
- Types -
-

SetNegotiableQuoteShippingAddressOutput

-
-
-
-
Description
-

Contains the negotiable quote.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- quote - - - NegotiableQuote - - The negotiable quote after assigning a shipping address.
-
-
-
-
-
Example
- - - 
{"quote": NegotiableQuote}
-
- -
-
-
-
-
-
- Types -
-

SetNegotiableQuoteShippingMethodsInput

-
-
-
-
Description
-

Defines the shipping method to apply to the negotiable quote.

-
-
-
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
- - - 
{
-  "quote_uid": "4",
-  "shipping_methods": [ShippingMethodInput]
-}
-
- -
-
-
-
-
-
- Types -
-

SetNegotiableQuoteShippingMethodsOutput

-
-
-
-
Description
-

Contains the negotiable quote.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- quote - - - NegotiableQuote - - The negotiable quote after applying shipping methods.
-
-
-
-
-
Example
- - - 
{"quote": NegotiableQuote}
-
- -
-
-
-
-
-
- Types -
-

SetPaymentMethodAndPlaceOrderInput

-
-
-
-
Description
-

Applies a payment method to the quote.

-
-
-
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
- - - 
{
-  "cart_id": "xyz789",
-  "payment_method": PaymentMethodInput
-}
-
- -
-
-
-
-
-
- Types -
-

SetPaymentMethodOnCartInput

-
-
-
-
Description
-

Applies a payment method to the cart.

-
-
-
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
- - - 
{
-  "cart_id": "abc123",
-  "payment_method": PaymentMethodInput
-}
-
- -
-
-
-
-
-
- Types -
-

SetPaymentMethodOnCartOutput

-
-
-
-
Description
-

Contains details about the cart after setting the payment method.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- cart - - - Cart! - - The cart after setting the payment method.
-
-
-
-
-
Example
- - - 
{"cart": Cart}
-
- -
-
-
-
-
-
- Types -
-

SetShippingAddressesOnCartInput

-
-
-
-
Description
-

Specifies an array of addresses to use for shipping.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Input FieldDescription
- cart_id - - - String! - - -

The unique ID of a Cart object.

-
- shipping_addresses - - - [ShippingAddressInput]! - - -

An array of shipping addresses.

-
-
-
-
-
-
Example
- - - 
{
-  "cart_id": "xyz789",
-  "shipping_addresses": [ShippingAddressInput]
-}
-
- -
-
-
-
-
-
- Types -
-

SetShippingAddressesOnCartOutput

-
-
-
-
Description
-

Contains details about the cart after setting the shipping addresses.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- cart - - - Cart! - - The cart after setting the shipping addresses.
-
-
-
-
-
Example
- - - 
{"cart": Cart}
-
- -
-
-
-
-
-
- Types -
-

SetShippingMethodsOnCartInput

-
-
-
-
Description
-

Applies one or shipping methods to the cart.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Input FieldDescription
- cart_id - - - String! - - -

The unique ID of a Cart object.

-
- shipping_methods - - - [ShippingMethodInput]! - - -

An array of shipping methods.

-
-
-
-
-
-
Example
- - - 
{
-  "cart_id": "abc123",
-  "shipping_methods": [ShippingMethodInput]
-}
-
- -
-
-
-
-
-
- Types -
-

SetShippingMethodsOnCartOutput

-
-
-
-
Description
-

Contains details about the cart after setting the shipping methods.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- cart - - - Cart! - - The cart after setting the shipping methods.
-
-
-
-
-
Example
- - - 
{"cart": Cart}
-
- -
-
-
-
-
-
- Types -
-

ShareGiftRegistryInviteeInput

-
-
-
-
Description
-

Defines a gift registry invitee.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Input FieldDescription
- email - - - String! - - -

The email address of the gift registry invitee.

-
- name - - - String! - - -

The name of the gift registry invitee.

-
-
-
-
-
-
Example
- - - 
{
-  "email": "xyz789",
-  "name": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

ShareGiftRegistryOutput

-
-
-
-
Description
-

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
- - - 
{"is_shared": false}
-
- -
-
-
-
-
-
- Types -
-

ShareGiftRegistrySenderInput

-
-
-
-
Description
-

Defines the sender of an invitation to view a gift registry.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Input FieldDescription
- message - - - String! - - -

A brief message from the sender.

-
- name - - - String! - - -

The sender of the gift registry invitation.

-
-
-
-
-
-
Example
- - - 
{
-  "message": "abc123",
-  "name": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

ShipBundleItemsEnum

-
-
-
-
Description
-

Defines whether bundle items must be shipped together.

-
-
-
Values
- - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

TOGETHER

-
-

SEPARATELY

-
-
-
-
-
-
Example
- - - 
"TOGETHER"
-
- -
-
-
-
-
-
- Types -
-

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
- - - 
{
-  "id": 4,
-  "order_item": OrderItemInterface,
-  "product_name": "xyz789",
-  "product_sale_price": Money,
-  "product_sku": "abc123",
-  "quantity_shipped": 123.45
-}
-
- -
-
-
-
-
-
- Types -
-

ShipmentItemInterface

-
-
-
-
Description
-

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
- - - 
{
-  "id": "4",
-  "order_item": OrderItemInterface,
-  "product_name": "xyz789",
-  "product_sale_price": Money,
-  "product_sku": "abc123",
-  "quantity_shipped": 123.45
-}
-
- -
-
-
-
-
-
- Types -
-

ShipmentTracking

-
-
-
-
Description
-

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
- - - 
{
-  "carrier": "abc123",
-  "number": "abc123",
-  "title": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

ShippingAddressInput

-
-
-
-
Description
-

Defines a single shipping address.

-
-
-
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_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
- - - 
{
-  "address": CartAddressInput,
-  "customer_address_id": 123,
-  "customer_notes": "xyz789",
-  "pickup_location_code": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

ShippingCartAddress

-
-
-
-
Description
-

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] - - - 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.
- customer_notes - - - String - - Text provided by the shopper.
- firstname - - - String! - - The first name of the customer or guest.
- items_weight - - - Float - - - This information should not be exposed on the frontend. -
- lastname - - - String! - - The last name of the customer or guest.
- pickup_location_code - - - String - -
- postcode - - - String - - The ZIP or postal code of the billing or shipping address.
- region - - - CartAddressRegion - - An object containing the region label and code.
- 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.
- telephone - - - String - - The telephone number for the billing or shipping address.
- uid - - - String! - - The unique id of the customer address.
- vat_id - - - String - - The VAT company number for billing or shipping address.
-
-
-
-
-
Example
- - - 
{
-  "available_shipping_methods": [AvailableShippingMethod],
-  "cart_items": [CartItemQuantity],
-  "cart_items_v2": [CartItemInterface],
-  "city": "abc123",
-  "company": "xyz789",
-  "country": CartAddressCountry,
-  "customer_notes": "xyz789",
-  "firstname": "abc123",
-  "items_weight": 987.65,
-  "lastname": "abc123",
-  "pickup_location_code": "xyz789",
-  "postcode": "abc123",
-  "region": CartAddressRegion,
-  "selected_shipping_method": SelectedShippingMethod,
-  "street": ["xyz789"],
-  "telephone": "xyz789",
-  "uid": "abc123",
-  "vat_id": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

ShippingDiscount

-
-
-
-
Description
-

Defines an individual shipping discount. This discount can be applied to shipping.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- amount - - - Money! - - The amount of the discount.
-
-
-
-
-
Example
- - - 
{"amount": Money}
-
- -
-
-
-
-
-
- Types -
-

ShippingHandling

-
-
-
-
Description
-

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
- - - 
{
-  "amount_excluding_tax": Money,
-  "amount_including_tax": Money,
-  "discounts": [ShippingDiscount],
-  "taxes": [TaxItem],
-  "total_amount": Money
-}
-
- -
-
-
-
-
-
- Types -
-

ShippingMethodInput

-
-
-
-
Description
-

Defines the shipping carrier and method.

-
-
-
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
- - - 
{
-  "carrier_code": "abc123",
-  "method_code": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

SimpleCartItem

-
-
-
-
Description
-

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.
- 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! - - - Use uid instead. -
- 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
- - - 
{
-  "available_gift_wrapping": [GiftWrapping],
-  "customizable_options": [SelectedCustomizableOption],
-  "errors": [CartItemError],
-  "gift_message": GiftMessage,
-  "gift_wrapping": GiftWrapping,
-  "id": "abc123",
-  "prices": CartItemPrices,
-  "product": ProductInterface,
-  "quantity": 123.45,
-  "uid": 4
-}
-
- -
-
-
-
-
-
- Types -
-

SimpleProduct

-
-
-
-
Description
-

Defines a simple product, which is tangible and is usually sold in single units or in fixed quantities.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- activity - - - String - - - Use the custom_attributes field instead. -
- attribute_set_id - - - Int - - The attribute set assigned to the product. - 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.
- category_gear - - - String - - - Use the custom_attributes field instead. -
- climate - - - String - - - Use the custom_attributes field instead. -
- collar - - - String - - - Use the custom_attributes field instead. -
- color - - - Int - - - 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. - The field should not be used on the storefront. -
- crosssell_products - - - [ProductInterface] - - An array of cross-sell products.
- description - - - ComplexTextValue - - Detailed information about the product. The value can include simple HTML tags.
- eco_collection - - - Int - - - Use the custom_attributes field instead. -
- erin_recommends - - - Int - - - Use the custom_attributes field instead. -
- features_bags - - - String - - - Use the custom_attributes field instead. -
- format - - - Int - - - Use the custom_attributes field instead. -
- gender - - - String - - - Use the custom_attributes field instead. -
- gift_message_available - - - String - - Indicates whether a gift message is available.
- id - - - Int - - The ID number assigned to the product. - 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. - Use the custom_attributes field instead. -
- material - - - String - - - Use the custom_attributes field instead. -
- media_gallery - - - [MediaGalleryInterface] - - An array of media gallery objects.
- media_gallery_entries - - - [MediaGalleryEntry] - - An array of MediaGalleryEntry objects. - 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.
- name - - - String - - The product name. Customers use this name to identify the product.
- new - - - Int - - - Use the custom_attributes field instead. -
- 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.
- pattern - - - String - - - Use the custom_attributes field instead. -
- performance_fabric - - - Int - - - Use the custom_attributes field instead. -
- price - - - ProductPrices - - Indicates the price of an item. - 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.
- purpose - - - Int - - - Use the custom_attributes field instead. -
- 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.
-
-
Arguments
-
-
-
- pageSize - - - Int - -
-

The maximum number of results to return at once. The default is 20.

-
-
-
- currentPage - - - Int - -
-

The page of results to return. The default is 1.

-
-
-
-
- sale - - - Int - - - Use the custom_attributes field instead. -
- short_description - - - ComplexTextValue - - A short description of the product. Its use depends on the theme.
- size - - - Int - - - Use the custom_attributes field instead. -
- sku - - - String - - A number or code assigned to a product to identify the product, options, price, and manufacturer.
- sleeve - - - String - - - Use the custom_attributes field instead. -
- 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. - 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
- strap_bags - - - String - - - Use the custom_attributes field instead. -
- style_bags - - - String - - - Use the custom_attributes field instead. -
- style_bottom - - - String - - - Use the custom_attributes field instead. -
- style_general - - - String - - - Use the custom_attributes field instead. -
- 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. - Use price_tiers for product tier price information. -
- tier_prices - - - [ProductTierPrices] - - An array of ProductTierPrices objects. - 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. - Use __typename instead. -
- uid - - - ID! - - The unique ID for a ProductInterface object.
- updated_at - - - String - - Timestamp indicating when the product was updated. - 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 - - - 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. - The field should not be used on the storefront. -
- weight - - - Float - - The weight of the item, in units defined by the store.
-
-
-
-
-
Example
- - - 
{
-  "activity": "abc123",
-  "attribute_set_id": 123,
-  "canonical_url": "abc123",
-  "categories": [CategoryInterface],
-  "category_gear": "abc123",
-  "climate": "abc123",
-  "collar": "xyz789",
-  "color": 987,
-  "country_of_manufacture": "xyz789",
-  "created_at": "abc123",
-  "crosssell_products": [ProductInterface],
-  "description": ComplexTextValue,
-  "eco_collection": 123,
-  "erin_recommends": 123,
-  "features_bags": "abc123",
-  "format": 987,
-  "gender": "abc123",
-  "gift_message_available": "xyz789",
-  "id": 123,
-  "image": ProductImage,
-  "is_returnable": "xyz789",
-  "manufacturer": 123,
-  "material": "abc123",
-  "media_gallery": [MediaGalleryInterface],
-  "media_gallery_entries": [MediaGalleryEntry],
-  "meta_description": "xyz789",
-  "meta_keyword": "abc123",
-  "meta_title": "abc123",
-  "name": "xyz789",
-  "new": 123,
-  "new_from_date": "xyz789",
-  "new_to_date": "xyz789",
-  "only_x_left_in_stock": 987.65,
-  "options": [CustomizableOptionInterface],
-  "options_container": "abc123",
-  "pattern": "abc123",
-  "performance_fabric": 123,
-  "price": ProductPrices,
-  "price_range": PriceRange,
-  "price_tiers": [TierPrice],
-  "product_links": [ProductLinksInterface],
-  "purpose": 987,
-  "rating_summary": 987.65,
-  "redirect_code": 987,
-  "related_products": [ProductInterface],
-  "relative_url": "abc123",
-  "review_count": 123,
-  "reviews": ProductReviews,
-  "sale": 123,
-  "short_description": ComplexTextValue,
-  "size": 123,
-  "sku": "abc123",
-  "sleeve": "abc123",
-  "small_image": ProductImage,
-  "special_from_date": "abc123",
-  "special_price": 123.45,
-  "special_to_date": "abc123",
-  "staged": true,
-  "stock_status": "IN_STOCK",
-  "strap_bags": "xyz789",
-  "style_bags": "xyz789",
-  "style_bottom": "xyz789",
-  "style_general": "abc123",
-  "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
-}
-
- -
-
-
-
-
-
- Types -
-

SimpleProductCartItemInput

-
-
-
-
Description
-

Defines a single product to add to the cart.

-
-
-
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
- - - 
{
-  "customizable_options": [CustomizableOptionInput],
-  "data": CartItemInput
-}
-
- -
-
-
-
-
-
- Types -
-

SimpleRequisitionListItem

-
-
-
-
Description
-

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
- - - 
{
-  "customizable_options": [SelectedCustomizableOption],
-  "product": ProductInterface,
-  "quantity": 123.45,
-  "uid": "4"
-}
-
- -
-
-
-
-
-
- Types -
-

SimpleWishlistItem

-
-
-
-
Description
-

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
- - - 
{
-  "added_at": "abc123",
-  "customizable_options": [SelectedCustomizableOption],
-  "description": "abc123",
-  "id": 4,
-  "product": ProductInterface,
-  "quantity": 123.45
-}
-
- -
-
-
-
-
-
- Types -
-

SortEnum

-
-
-
-
Description
-

Indicates whether to return results in ascending or descending order.

-
-
-
Values
- - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

ASC

-
-

DESC

-
-
-
-
-
-
Example
- - - 
"ASC"
-
- -
-
-
-
-
-
- Types -
-

SortField

-
-
-
-
Description
-

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
- - - 
{
-  "label": "abc123",
-  "value": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

SortFields

-
-
-
-
Description
-

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
- - - 
{
-  "default": "abc123",
-  "options": [SortField]
-}
-
- -
-
-
-
-
-
- Types -
-

StoreConfig

-
-
-
-
Description
-

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_cc_vault_active - - - String - - Braintree cc vault status.
- cart_gift_wrapping - - - String - - Indicates if gift wrapping prices are displayed on the Shopping Cart page. Possible values: 1 (Yes) and 0 (No).
- cart_printed_card - - - String - - Indicates if printed card prices are displayed on the Shopping Cart page. Possible values: 1 (Yes) and 0 (No).
- 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. - Use store_code instead. -
- configurable_thumbnail_source - - - String - - Indicates whether the parent or child (itself) thumbnail should be used in the cart for configurable products.
- copyright - - - String - - The copyright statement that appears at the bottom of each page.
- 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).
- enable_multiple_wishlists - - - String - - Indicates whether customers can have multiple wish lists. Possible values: 1 (Yes) and 0 (No).
- front - - - String - - The landing page that is associated with the base URL.
- 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.
- 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. - Use store_code instead. -
- 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_negotiable_quote_active - - - Boolean - - Indicates whether negotiable quote functionality is enabled.
- 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).
- maximum_number_of_wishlists - - - String - - If multiple wish lists are enabled, the maximum number of wish lists the customer can have.
- minimum_password_length - - - String - - The minimum number of characters required for a valid password.
- no_route - - - String - - The default page that displays when a 404 'Page not Found' error occurs.
- 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.
- 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.
- 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. - 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.
- 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. - 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
- - - 
{
-  "absolute_footer": "abc123",
-  "allow_gift_receipt": "abc123",
-  "allow_gift_wrapping_on_order": "abc123",
-  "allow_gift_wrapping_on_order_items": "abc123",
-  "allow_guests_to_write_product_reviews": "abc123",
-  "allow_items": "xyz789",
-  "allow_order": "abc123",
-  "allow_printed_card": "xyz789",
-  "autocomplete_on_storefront": true,
-  "base_currency_code": "xyz789",
-  "base_link_url": "abc123",
-  "base_media_url": "xyz789",
-  "base_static_url": "xyz789",
-  "base_url": "xyz789",
-  "braintree_cc_vault_active": "abc123",
-  "cart_gift_wrapping": "xyz789",
-  "cart_printed_card": "abc123",
-  "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": "abc123",
-  "check_money_order_max_order_total": "abc123",
-  "check_money_order_min_order_total": "abc123",
-  "check_money_order_new_order_status": "abc123",
-  "check_money_order_payment_from_specific_countries": "xyz789",
-  "check_money_order_send_check_to": "xyz789",
-  "check_money_order_sort_order": 987,
-  "check_money_order_title": "xyz789",
-  "cms_home_page": "abc123",
-  "cms_no_cookies": "xyz789",
-  "cms_no_route": "abc123",
-  "code": "abc123",
-  "configurable_thumbnail_source": "abc123",
-  "copyright": "abc123",
-  "default_description": "abc123",
-  "default_display_currency_code": "xyz789",
-  "default_keywords": "abc123",
-  "default_title": "xyz789",
-  "demonotice": 987,
-  "enable_multiple_wishlists": "xyz789",
-  "front": "xyz789",
-  "grid_per_page": 987,
-  "grid_per_page_values": "abc123",
-  "head_includes": "xyz789",
-  "head_shortcut_icon": "xyz789",
-  "header_logo_src": "xyz789",
-  "id": 123,
-  "is_default_store": true,
-  "is_default_store_group": false,
-  "is_negotiable_quote_active": false,
-  "is_requisition_list_active": "abc123",
-  "list_mode": "abc123",
-  "list_per_page": 123,
-  "list_per_page_values": "abc123",
-  "locale": "xyz789",
-  "logo_alt": "abc123",
-  "logo_height": 123,
-  "logo_width": 123,
-  "magento_reward_general_is_enabled": "abc123",
-  "magento_reward_general_is_enabled_on_front": "abc123",
-  "magento_reward_general_min_points_balance": "xyz789",
-  "magento_reward_general_publish_history": "abc123",
-  "magento_reward_points_invitation_customer": "abc123",
-  "magento_reward_points_invitation_customer_limit": "xyz789",
-  "magento_reward_points_invitation_order": "abc123",
-  "magento_reward_points_invitation_order_limit": "xyz789",
-  "magento_reward_points_newsletter": "abc123",
-  "magento_reward_points_order": "xyz789",
-  "magento_reward_points_register": "abc123",
-  "magento_reward_points_review": "xyz789",
-  "magento_reward_points_review_limit": "xyz789",
-  "magento_wishlist_general_is_enabled": "abc123",
-  "maximum_number_of_wishlists": "abc123",
-  "minimum_password_length": "abc123",
-  "no_route": "abc123",
-  "payment_payflowpro_cc_vault_active": "xyz789",
-  "printed_card_price": "xyz789",
-  "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
-  "product_reviews_enabled": "xyz789",
-  "product_url_suffix": "xyz789",
-  "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": "xyz789",
-  "secure_base_link_url": "abc123",
-  "secure_base_media_url": "abc123",
-  "secure_base_static_url": "abc123",
-  "secure_base_url": "xyz789",
-  "send_friend": SendFriendConfiguration,
-  "show_cms_breadcrumbs": 123,
-  "store_code": "4",
-  "store_group_code": 4,
-  "store_group_name": "xyz789",
-  "store_name": "abc123",
-  "store_sort_order": 987,
-  "timezone": "abc123",
-  "title_prefix": "xyz789",
-  "title_separator": "abc123",
-  "title_suffix": "abc123",
-  "use_store_in_url": true,
-  "website_code": "4",
-  "website_id": 987,
-  "website_name": "abc123",
-  "weight_unit": "abc123",
-  "welcome": "abc123",
-  "zero_subtotal_enable_for_specific_countries": false,
-  "zero_subtotal_enabled": false,
-  "zero_subtotal_new_order_status": "xyz789",
-  "zero_subtotal_payment_action": "abc123",
-  "zero_subtotal_payment_from_specific_countries": "xyz789",
-  "zero_subtotal_sort_order": 123,
-  "zero_subtotal_title": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

StorefrontProperties

-
-
-
-
Description
-

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
- - - 
{
-  "position": 123,
-  "use_in_layered_navigation": "NO",
-  "use_in_product_listing": true,
-  "use_in_search_results_layered_navigation": false,
-  "visible_on_catalog_pages": true
-}
-
- -
-
-
-
-
-
- Types -
-

String

-
-
-
-
Description
-

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
- - - 
"xyz789"
-
- -
-
-
-
-
-
- Types -
-

SubscribeEmailToNewsletterOutput

-
-
-
-
Description
-

Contains the result of the subscribeEmailToNewsletter operation.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- status - - - SubscriptionStatusesEnum - - The status of the subscription request.
-
-
-
-
-
Example
- - - 
{"status": "NOT_ACTIVE"}
-
- -
-
-
-
-
-
- Types -
-

SubscriptionStatusesEnum

-
-
-
-
Description
-

Indicates the status of the request.

-
-
-
Values
- - - - - - - - - - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

NOT_ACTIVE

-
-

SUBSCRIBED

-
-

UNSUBSCRIBED

-
-

UNCONFIRMED

-
-
-
-
-
-
Example
- - - 
"NOT_ACTIVE"
-
- -
-
-
-
-
-
- Types -
-

SwatchData

-
-
-
-
Description
-

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
- - - 
{
-  "type": "abc123",
-  "value": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

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
- - - 
{"value": "xyz789"}
-
- -
-
-
-
-
-
- Types -
-

SwatchLayerFilterItem

-
-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- items_count - - - Int - - The count of items per filter. - Use AggregationOption.count instead. -
- label - - - String - - The label for a filter. - 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. - Use AggregationOption.value instead. -
-
-
-
-
-
Example
- - - 
{
-  "items_count": 123,
-  "label": "xyz789",
-  "swatch_data": SwatchData,
-  "value_string": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

SwatchLayerFilterItemInterface

-
-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- swatch_data - - - SwatchData - - Data required to render a swatch filter item.
-
-
-
Possible Types
- - - - - - - - - - - -
SwatchLayerFilterItemInterface Types
-

- SwatchLayerFilterItem -

-
-
-
-
-
-
Example
- - - 
{"swatch_data": SwatchData}
-
- -
-
-
-
-
-
- Types -
-

TaxItem

-
-
-
-
Description
-

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
- - - 
{
-  "amount": Money,
-  "rate": 987.65,
-  "title": "xyz789"
-}
-
- -
-
-
-
-
-
- Types -
-

TextSwatchData

-
-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- value - - - String - - The value can be represented as color (HEX code), image link, or text.
-
-
-
-
-
Example
- - - 
{"value": "abc123"}
-
- -
-
-
-
-
-
- Types -
-

TierPrice

-
-
-
-
Description
-

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
- - - 
{
-  "discount": ProductDiscount,
-  "final_price": Money,
-  "quantity": 123.45
-}
-
- -
-
-
-
-
-
- Types -
-

UpdateCartItemsInput

-
-
-
-
Description
-

Modifies the specified items in the cart.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Input FieldDescription
- cart_id - - - String! - - -

The unique ID of a Cart object.

-
- cart_items - - - [CartItemUpdateInput]! - - -

An array of items to be updated.

-
-
-
-
-
-
Example
- - - 
{
-  "cart_id": "abc123",
-  "cart_items": [CartItemUpdateInput]
-}
-
- -
-
-
-
-
-
- Types -
-

UpdateCartItemsOutput

-
-
-
-
Description
-

Contains details about the cart after updating items.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- cart - - - Cart! - - The cart after updating products.
-
-
-
-
-
Example
- - - 
{"cart": Cart}
-
- -
-
-
-
-
-
- Types -
-

UpdateCompanyOutput

-
-
-
-
Description
-

Contains the response to the request to update the company.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- company - - - Company! - - The updated company instance.
-
-
-
-
-
Example
- - - 
{"company": Company}
-
- -
-
-
-
-
-
- Types -
-

UpdateCompanyRoleOutput

-
-
-
-
Description
-

Contains the response to the request to update the company role.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- role - - - CompanyRole! - - The updated company role instance.
-
-
-
-
-
Example
- - - 
{"role": CompanyRole}
-
- -
-
-
-
-
-
- Types -
-

UpdateCompanyStructureOutput

-
-
-
-
Description
-

Contains the response to the request to update the company structure.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- company - - - Company! - - The updated company instance.
-
-
-
-
-
Example
- - - 
{"company": Company}
-
- -
-
-
-
-
-
- Types -
-

UpdateCompanyTeamOutput

-
-
-
-
Description
-

Contains the response to the request to update a company team.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- team - - - CompanyTeam! - - The updated company team instance.
-
-
-
-
-
Example
- - - 
{"team": CompanyTeam}
-
- -
-
-
-
-
-
- Types -
-

UpdateCompanyUserOutput

-
-
-
-
Description
-

Contains the response to the request to update the company user.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- user - - - Customer! - - The updated company user instance.
-
-
-
-
-
Example
- - - 
{"user": Customer}
-
- -
-
-
-
-
-
- Types -
-

UpdateGiftRegistryInput

-
-
-
-
Description
-

Defines updates to a GiftRegistry object.

-
-
-
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
- - - 
{
-  "dynamic_attributes": [
-    GiftRegistryDynamicAttributeInput
-  ],
-  "event_name": "xyz789",
-  "message": "abc123",
-  "privacy_settings": "PRIVATE",
-  "shipping_address": GiftRegistryShippingAddressInput,
-  "status": "ACTIVE"
-}
-
- -
-
-
-
-
-
- Types -
-

UpdateGiftRegistryItemInput

-
-
-
-
Description
-

Defines updates to an item in a gift registry.

-
-
-
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
- - - 
{
-  "gift_registry_item_uid": 4,
-  "note": "abc123",
-  "quantity": 123.45
-}
-
- -
-
-
-
-
-
- Types -
-

UpdateGiftRegistryItemsOutput

-
-
-
-
Description
-

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
- - - 
{"gift_registry": GiftRegistry}
-
- -
-
-
-
-
-
- Types -
-

UpdateGiftRegistryOutput

-
-
-
-
Description
-

Contains the results of a request to update a gift registry.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- gift_registry - - - GiftRegistry - - The updated gift registry.
-
-
-
-
-
Example
- - - 
{"gift_registry": GiftRegistry}
-
- -
-
-
-
-
-
- Types -
-

UpdateGiftRegistryRegistrantInput

-
-
-
-
Description
-

Defines updates to an existing registrant.

-
-
-
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
- - - 
{
-  "dynamic_attributes": [
-    GiftRegistryDynamicAttributeInput
-  ],
-  "email": "xyz789",
-  "firstname": "abc123",
-  "gift_registry_registrant_uid": "4",
-  "lastname": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

UpdateGiftRegistryRegistrantsOutput

-
-
-
-
Description
-

Contains the results a request to update registrants.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- gift_registry - - - GiftRegistry - - The gift registry after updating registrants.
-
-
-
-
-
Example
- - - 
{"gift_registry": GiftRegistry}
-
- -
-
-
-
-
-
- Types -
-

UpdateNegotiableQuoteItemsQuantityOutput

-
-
-
-
Description
-

Contains the updated negotiable quote.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- quote - - - NegotiableQuote - - The updated negotiable quote.
-
-
-
-
-
Example
- - - 
{"quote": NegotiableQuote}
-
- -
-
-
-
-
-
- Types -
-

UpdateNegotiableQuoteQuantitiesInput

-
-
-
-
Description
-

Specifies the items to update.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Input FieldDescription
- items - - - [NegotiableQuoteItemQuantityInput]! - - -

An array of items to update.

-
- quote_uid - - - ID! - - -

The unique ID of a NegotiableQuote object.

-
-
-
-
-
-
Example
- - - 
{
-  "items": [NegotiableQuoteItemQuantityInput],
-  "quote_uid": "4"
-}
-
- -
-
-
-
-
-
- Types -
-

UpdateProductsInWishlistOutput

-
-
-
-
Description
-

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
- - - 
{
-  "user_errors": [WishListUserInputError],
-  "wishlist": Wishlist
-}
-
- -
-
-
-
-
-
- Types -
-

UpdatePurchaseOrderApprovalRuleInput

-
-
-
-
Description
-

Defines the changes to be made to an approval rule.

-
-
-
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
- - - 
{
-  "applies_to": [4],
-  "approvers": ["4"],
-  "condition": CreatePurchaseOrderApprovalRuleConditionInput,
-  "description": "xyz789",
-  "name": "abc123",
-  "status": "ENABLED",
-  "uid": "4"
-}
-
- -
-
-
-
-
-
- Types -
-

UpdateRequisitionListInput

-
-
-
-
Description
-

An input object that defines which requistion list characteristics to update.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Input FieldDescription
- description - - - String - - -

The updated description of the requisition list.

-
- name - - - String! - - -

The new name of the requisition list.

-
-
-
-
-
-
Example
- - - 
{
-  "description": "xyz789",
-  "name": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

UpdateRequisitionListItemsInput

-
-
-
-
Description
-

Defines which items in a requisition list to update.

-
-
-
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
- - - 
{
-  "entered_options": [EnteredOptionInput],
-  "item_id": 4,
-  "quantity": 987.65,
-  "selected_options": ["xyz789"]
-}
-
- -
-
-
-
-
-
- Types -
-

UpdateRequisitionListItemsOutput

-
-
-
-
Description
-

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
- - - 
{"requisition_list": RequisitionList}
-
- -
-
-
-
-
-
- Types -
-

UpdateRequisitionListOutput

-
-
-
-
Description
-

Output of the request to rename the requisition list.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- requisition_list - - - RequisitionList - - The renamed requisition list.
-
-
-
-
-
Example
- - - 
{"requisition_list": RequisitionList}
-
- -
-
-
-
-
-
- Types -
-

UpdateWishlistOutput

-
-
-
-
Description
-

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
- - - 
{
-  "name": "abc123",
-  "uid": "4",
-  "visibility": "PUBLIC"
-}
-
- -
-
-
-
-
-
- Types -
-

UrlRewrite

-
-
-
-
Description
-

Contains URL rewrite details.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- parameters - - - [HttpQueryParameter] - - An array of request parameters.
- url - - - String - - The request URL.
-
-
-
-
-
Example
- - - 
{
-  "parameters": [HttpQueryParameter],
-  "url": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

UrlRewriteEntityTypeEnum

-
-
-
-
Description
-

This enumeration defines the entity type.

-
-
-
Values
- - - - - - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

CMS_PAGE

-
-

PRODUCT

-
-

CATEGORY

-
-
-
-
-
-
Example
- - - 
"CMS_PAGE"
-
- -
-
-
-
-
-
- Types -
-

UseInLayeredNavigationOptions

-
-
-
-
Description
-

Defines whether the attribute is filterable in layered navigation.

-
-
-
Values
- - - - - - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

NO

-
-

FILTERABLE_WITH_RESULTS

-
-

FILTERABLE_NO_RESULT

-
-
-
-
-
-
Example
- - - 
"NO"
-
- -
-
-
-
-
-
- Types -
-

ValidatePurchaseOrderError

-
-
-
-
Description
-

Contains details about a failed validation attempt.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- message - - - String! - - The returned error message.
- type - - - ValidatePurchaseOrderErrorType! - - Error type.
-
-
-
-
-
Example
- - - 
{"message": "abc123", "type": "NOT_FOUND"}
-
- -
-
-
-
-
-
- Types -
-

ValidatePurchaseOrderErrorType

-
-
-
-
Values
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

NOT_FOUND

-
-

OPERATION_NOT_APPLICABLE

-
-

COULD_NOT_SAVE

-
-

NOT_VALID_DATA

-
-

UNDEFINED

-
-
-
-
-
-
Example
- - - 
"NOT_FOUND"
-
- -
-
-
-
-
-
- Types -
-

ValidatePurchaseOrdersInput

-
-
-
-
Description
-

Defines the purchase orders to be validated.

-
-
-
Fields
- - - - - - - - - - - - - -
Input FieldDescription
- purchase_order_uids - - - [ID]! - - -

An array of the purchase order IDs.

-
-
-
-
-
-
Example
- - - 
{"purchase_order_uids": [4]}
-
- -
-
-
-
-
-
- Types -
-

ValidatePurchaseOrdersOutput

-
-
-
-
Description
-

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
- - - 
{
-  "errors": [ValidatePurchaseOrderError],
-  "purchase_orders": [PurchaseOrder]
-}
-
- -
-
-
-
-
-
- Types -
-

VaultTokenInput

-
-
-
-
Description
-

Contains required input for payment methods with Vault support.

-
-
-
Fields
- - - - - - - - - - - - - -
Input FieldDescription
- public_hash - - - String! - - -

The public hash of the payment token.

-
-
-
-
-
-
Example
- - - 
{"public_hash": "abc123"}
-
- -
-
-
-
-
-
- Types -
-

VirtualCartItem

-
-
-
-
Description
-

An implementation for virtual product cart items.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- customizable_options - - - [SelectedCustomizableOption]! - - An array containing customizable options the shopper selected.
- errors - - - [CartItemError] - - An array of errors encountered while loading the cart item
- id - - - String! - - - Use uid instead. -
- 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
- - - 
{
-  "customizable_options": [SelectedCustomizableOption],
-  "errors": [CartItemError],
-  "id": "abc123",
-  "prices": CartItemPrices,
-  "product": ProductInterface,
-  "quantity": 123.45,
-  "uid": 4
-}
-
- -
-
-
-
-
-
- Types -
-

VirtualProduct

-
-
-
-
Description
-

Defines a virtual product, which is a non-tangible product that does not require shipping and is not kept in inventory.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- activity - - - String - - - Use the custom_attributes field instead. -
- attribute_set_id - - - Int - - The attribute set assigned to the product. - 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.
- category_gear - - - String - - - Use the custom_attributes field instead. -
- climate - - - String - - - Use the custom_attributes field instead. -
- collar - - - String - - - Use the custom_attributes field instead. -
- color - - - Int - - - 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. - The field should not be used on the storefront. -
- crosssell_products - - - [ProductInterface] - - An array of cross-sell products.
- description - - - ComplexTextValue - - Detailed information about the product. The value can include simple HTML tags.
- eco_collection - - - Int - - - Use the custom_attributes field instead. -
- erin_recommends - - - Int - - - Use the custom_attributes field instead. -
- features_bags - - - String - - - Use the custom_attributes field instead. -
- format - - - Int - - - Use the custom_attributes field instead. -
- gender - - - String - - - Use the custom_attributes field instead. -
- gift_message_available - - - String - - Indicates whether a gift message is available.
- id - - - Int - - The ID number assigned to the product. - 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. - Use the custom_attributes field instead. -
- material - - - String - - - Use the custom_attributes field instead. -
- media_gallery - - - [MediaGalleryInterface] - - An array of media gallery objects.
- media_gallery_entries - - - [MediaGalleryEntry] - - An array of MediaGalleryEntry objects. - 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.
- name - - - String - - The product name. Customers use this name to identify the product.
- new - - - Int - - - Use the custom_attributes field instead. -
- 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.
- pattern - - - String - - - Use the custom_attributes field instead. -
- performance_fabric - - - Int - - - Use the custom_attributes field instead. -
- price - - - ProductPrices - - Indicates the price of an item. - 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.
- purpose - - - Int - - - Use the custom_attributes field instead. -
- 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.
-
-
Arguments
-
-
-
- pageSize - - - Int - -
-

The maximum number of results to return at once. The default is 20.

-
-
-
- currentPage - - - Int - -
-

The page of results to return. The default is 1.

-
-
-
-
- sale - - - Int - - - Use the custom_attributes field instead. -
- short_description - - - ComplexTextValue - - A short description of the product. Its use depends on the theme.
- size - - - Int - - - Use the custom_attributes field instead. -
- sku - - - String - - A number or code assigned to a product to identify the product, options, price, and manufacturer.
- sleeve - - - String - - - Use the custom_attributes field instead. -
- 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. - 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
- strap_bags - - - String - - - Use the custom_attributes field instead. -
- style_bags - - - String - - - Use the custom_attributes field instead. -
- style_bottom - - - String - - - Use the custom_attributes field instead. -
- style_general - - - String - - - Use the custom_attributes field instead. -
- 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. - Use price_tiers for product tier price information. -
- tier_prices - - - [ProductTierPrices] - - An array of ProductTierPrices objects. - 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. - Use __typename instead. -
- uid - - - ID! - - The unique ID for a ProductInterface object.
- updated_at - - - String - - Timestamp indicating when the product was updated. - 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 - - - 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. - The field should not be used on the storefront. -
-
-
-
-
-
Example
- - - 
{
-  "activity": "abc123",
-  "attribute_set_id": 123,
-  "canonical_url": "xyz789",
-  "categories": [CategoryInterface],
-  "category_gear": "xyz789",
-  "climate": "xyz789",
-  "collar": "abc123",
-  "color": 987,
-  "country_of_manufacture": "abc123",
-  "created_at": "xyz789",
-  "crosssell_products": [ProductInterface],
-  "description": ComplexTextValue,
-  "eco_collection": 123,
-  "erin_recommends": 987,
-  "features_bags": "xyz789",
-  "format": 987,
-  "gender": "abc123",
-  "gift_message_available": "xyz789",
-  "id": 123,
-  "image": ProductImage,
-  "is_returnable": "abc123",
-  "manufacturer": 987,
-  "material": "abc123",
-  "media_gallery": [MediaGalleryInterface],
-  "media_gallery_entries": [MediaGalleryEntry],
-  "meta_description": "abc123",
-  "meta_keyword": "xyz789",
-  "meta_title": "abc123",
-  "name": "xyz789",
-  "new": 123,
-  "new_from_date": "xyz789",
-  "new_to_date": "abc123",
-  "only_x_left_in_stock": 123.45,
-  "options": [CustomizableOptionInterface],
-  "options_container": "xyz789",
-  "pattern": "abc123",
-  "performance_fabric": 123,
-  "price": ProductPrices,
-  "price_range": PriceRange,
-  "price_tiers": [TierPrice],
-  "product_links": [ProductLinksInterface],
-  "purpose": 987,
-  "rating_summary": 123.45,
-  "redirect_code": 123,
-  "related_products": [ProductInterface],
-  "relative_url": "abc123",
-  "review_count": 123,
-  "reviews": ProductReviews,
-  "sale": 987,
-  "short_description": ComplexTextValue,
-  "size": 987,
-  "sku": "abc123",
-  "sleeve": "abc123",
-  "small_image": ProductImage,
-  "special_from_date": "abc123",
-  "special_price": 123.45,
-  "special_to_date": "abc123",
-  "staged": true,
-  "stock_status": "IN_STOCK",
-  "strap_bags": "abc123",
-  "style_bags": "abc123",
-  "style_bottom": "xyz789",
-  "style_general": "abc123",
-  "swatch_image": "abc123",
-  "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": "xyz789",
-  "url_path": "abc123",
-  "url_rewrites": [UrlRewrite],
-  "url_suffix": "xyz789",
-  "websites": [Website]
-}
-
- -
-
-
-
-
-
- Types -
-

VirtualProductCartItemInput

-
-
-
-
Description
-

Defines a single product to add to the cart.

-
-
-
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
- - - 
{
-  "customizable_options": [CustomizableOptionInput],
-  "data": CartItemInput
-}
-
- -
-
-
-
-
-
- Types -
-

VirtualRequisitionListItem

-
-
-
-
Description
-

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
- - - 
{
-  "customizable_options": [SelectedCustomizableOption],
-  "product": ProductInterface,
-  "quantity": 987.65,
-  "uid": "4"
-}
-
- -
-
-
-
-
-
- Types -
-

VirtualWishlistItem

-
-
-
-
Description
-

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
- - - 
{
-  "added_at": "xyz789",
-  "customizable_options": [SelectedCustomizableOption],
-  "description": "abc123",
-  "id": "4",
-  "product": ProductInterface,
-  "quantity": 123.45
-}
-
- -
-
-
-
-
-
- Types -
-

Website

-
-
-
-
Description
-

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. - The field should not be used on the storefront. -
- default_group_id - - - String - - The default group ID of the website. - The field should not be used on the storefront. -
- id - - - Int - - The ID number assigned to the website. - The field should not be used on the storefront. -
- is_default - - - Boolean - - Indicates whether this is the default website. - The field should not be used on the storefront. -
- name - - - String - - The website name. Websites use this name to identify it easier. - The field should not be used on the storefront. -
- sort_order - - - Int - - The attribute to use for sorting websites. - The field should not be used on the storefront. -
-
-
-
-
-
Example
- - - 
{
-  "code": "xyz789",
-  "default_group_id": "xyz789",
-  "id": 123,
-  "is_default": false,
-  "name": "abc123",
-  "sort_order": 987
-}
-
- -
-
-
-
-
-
- Types -
-

WishListUserInputError

-
-
-
-
Description
-

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
- - - 
{
-  "code": "PRODUCT_NOT_FOUND",
-  "message": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

WishListUserInputErrorType

-
-
-
-
Description
-

A list of possible error types.

-
-
-
Values
- - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

PRODUCT_NOT_FOUND

-
-

UNDEFINED

-
-
-
-
-
-
Example
- - - 
"PRODUCT_NOT_FOUND"
-
- -
-
-
-
-
-
- Types -
-

Wishlist

-
-
-
-
Description
-

Contains a customer wish list.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- id - - - ID - - The unique ID for a Wishlist object.
- items - - - [WishlistItem] - - - 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.
-
-
Arguments
-
-
-
- currentPage - - - Int - -
-
-
-
- pageSize - - - Int - -
-
-
-
-
- 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
- - - 
{
-  "id": 4,
-  "items": [WishlistItem],
-  "items_count": 123,
-  "items_v2": WishlistItems,
-  "name": "xyz789",
-  "sharing_code": "abc123",
-  "updated_at": "abc123",
-  "visibility": "PUBLIC"
-}
-
- -
-
-
-
-
-
- Types -
-

WishlistCartUserInputError

-
-
-
-
Description
-

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
- - - 
{
-  "code": "PRODUCT_NOT_FOUND",
-  "message": "abc123",
-  "wishlistId": "4",
-  "wishlistItemId": "4"
-}
-
- -
-
-
-
-
-
- Types -
-

WishlistCartUserInputErrorType

-
-
-
-
Description
-

A list of possible error types.

-
-
-
Values
- - - - - - - - - - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

PRODUCT_NOT_FOUND

-
-

NOT_SALABLE

-
-

INSUFFICIENT_STOCK

-
-

UNDEFINED

-
-
-
-
-
-
Example
- - - 
"PRODUCT_NOT_FOUND"
-
- -
-
-
-
-
-
- Types -
-

WishlistItem

-
-
-
-
Description
-

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
- - - 
{
-  "added_at": "abc123",
-  "description": "abc123",
-  "id": 987,
-  "product": ProductInterface,
-  "qty": 987.65
-}
-
- -
-
-
-
-
-
- Types -
-

WishlistItemCopyInput

-
-
-
-
Description
-

Specifies the IDs of items to copy and their quantities.

-
-
-
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
- - - 
{
-  "quantity": 987.65,
-  "wishlist_item_id": "4"
-}
-
- -
-
-
-
-
-
- Types -
-

WishlistItemInput

-
-
-
-
Description
-

Defines the items to add to a wish list.

-
-
-
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
- - - 
{
-  "entered_options": [EnteredOptionInput],
-  "parent_sku": "xyz789",
-  "quantity": 123.45,
-  "selected_options": ["4"],
-  "sku": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

WishlistItemInterface

-
-
-
-
Description
-

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 -

-
-

- DownloadableWishlistItem -

-
-

- BundleWishlistItem -

-
-

- GiftCardWishlistItem -

-
-

- GroupedProductWishlistItem -

-
-

- ConfigurableWishlistItem -

-
-
-
-
-
-
Example
- - - 
{
-  "added_at": "xyz789",
-  "customizable_options": [SelectedCustomizableOption],
-  "description": "abc123",
-  "id": "4",
-  "product": ProductInterface,
-  "quantity": 123.45
-}
-
- -
-
-
-
-
-
- Types -
-

WishlistItemMoveInput

-
-
-
-
Description
-

Specifies the IDs of the items to move and their quantities.

-
-
-
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
- - - 
{"quantity": 123.45, "wishlist_item_id": 4}
-
- -
-
-
-
-
-
- Types -
-

WishlistItemUpdateInput

-
-
-
-
Description
-

Defines updates to items in a wish list.

-
-
-
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
- - - 
{
-  "description": "abc123",
-  "entered_options": [EnteredOptionInput],
-  "quantity": 987.65,
-  "selected_options": [4],
-  "wishlist_item_id": "4"
-}
-
- -
-
-
-
-
-
- Types -
-

WishlistItems

-
-
-
-
Description
-

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
- - - 
{
-  "items": [WishlistItemInterface],
-  "page_info": SearchResultPageInfo
-}
-
- -
-
-
-
-
-
- Types -
-

WishlistOutput

-
-
-
-
Description
-

Deprecated: Use the Wishlist type instead.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- items - - - [WishlistItem] - - An array of items in the customer's wish list - Use the Wishlist.items field instead. -
- items_count - - - Int - - The number of items in the wish list. - Use the Wishlist.items_count field instead. -
- name - - - String - - When multiple wish lists are enabled, the name the customer assigns to the wishlist. - 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. - Use the Wishlist.sharing_code field instead. -
- updated_at - - - String - - The time of the last modification to the wish list. - Use the Wishlist.updated_at field instead. -
-
-
-
-
-
Example
- - - 
{
-  "items": [WishlistItem],
-  "items_count": 987,
-  "name": "abc123",
-  "sharing_code": "abc123",
-  "updated_at": "abc123"
-}
-
- -
-
-
-
-
-
- Types -
-

WishlistVisibilityEnum

-
-
-
-
Description
-

Defines the wish list visibility types.

-
-
-
Values
- - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

PUBLIC

-
-

PRIVATE

-
-
-
-
-
-
Example
- - - 
"PUBLIC"
-
- -
-
-
-
-
-
- Types -
-

createEmptyCartInput

-
-
-
-
Description
-

Assigns a specific cart_id to the empty cart.

-
-
-
Fields
- - - - - - - - - - - - - -
Input FieldDescription
- cart_id - - - String - - -

The ID to assign to the cart.

-
-
-
-
-
-
Example
- - - 
{"cart_id": "xyz789"}
-
- -
-
-
-
-
-
- Documentation by - Anvil SpectaQL - -
-
-
-
-
-
- - \ No newline at end of file diff --git a/static/graphql-api/beta/javascripts/spectaql.min.js b/static/graphql-api/beta/javascripts/spectaql.min.js deleted file mode 100644 index 45b7a25e6..000000000 --- a/static/graphql-api/beta/javascripts/spectaql.min.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";function scrollSpy(){var l=5,e=document.querySelector("html"),r=(e&&(e=window.getComputedStyle(e).scrollPaddingTop)&&"string"==typeof e&&"auto"!==e&&e.endsWith("px")&&(l+=parseInt(e.split("px")[0])),"nav-scroll-active"),i="nav-scroll-expand",d=null,s=[];function t(){d=null;var e=document.querySelectorAll("[data-traverse-target]");Array.prototype.forEach.call(e,function(e){s.push({id:e.id,top:e.offsetTop})})}var n=debounce(function(){t(),o()},500),o=debounce(function(){var e,t,n,o,c=function(e){for(var t=e+l,n=0;n=s[n].top&&(!o||t{toggleMenu(),scrollSpy()}); \ No newline at end of file diff --git a/static/graphql-api/beta/stylesheets/spectaql.min.css b/static/graphql-api/beta/stylesheets/spectaql.min.css deleted file mode 100644 index c1093ddaf..000000000 --- a/static/graphql-api/beta/stylesheets/spectaql.min.css +++ /dev/null @@ -1 +0,0 @@ -@import url(https://fonts.googleapis.com/css?family=Barlow:ital,wght@0,400;0,700;1,400;1,700&display=swap);#spectaql{padding:0;margin:0}#spectaql pre{overflow:auto;margin-top:0;margin-bottom:20px}#spectaql pre code{display:block;background:#505050}#spectaql table{width:100%;table-layout:fixed;text-align:left;border-collapse:collapse}#spectaql table td,#spectaql table th{margin:0;padding:0}#spectaql #introduction .example-section>*,#spectaql .definition-heading,#spectaql .doc-heading,#spectaql .introduction-item-title,#spectaql .operation-heading{overflow:hidden;text-overflow:ellipsis}#spectaql #page{display:flex}#spectaql #page *{box-sizing:border-box}#spectaql #page.drawer-open #sidebar{z-index:1000;transform:translateX(0)}#spectaql #page.drawer-open .drawer-overlay{display:block;background:rgba(0,0,0,.5);z-index:10}#spectaql #sidebar{position:fixed;min-width:250px;max-width:250px;flex-shrink:0;transition:transform .2s ease-out;transform:translateX(-100%);z-index:10;padding-top:20px;background:#fff}@media (min-width:48em){#spectaql #sidebar{position:relative;transform:none}}@media (min-width:64em){#spectaql #sidebar{min-width:300px;max-width:300px}}#spectaql .sidebar-top-container{display:flex;align-items:center;padding:0 20px}#spectaql #mobile-navbar{display:flex;align-items:center;position:sticky;top:0}@media (min-width:48em){#spectaql #mobile-navbar{display:none}}#spectaql .sidebar-open-button{display:flex;align-items:flex-start;margin:0;padding:0;border:none;background:0 0}#spectaql .sidebar-open-button .hamburger{width:16px;height:14px;cursor:pointer}#spectaql .sidebar-open-button .hamburger::after{display:block;content:"";height:2px;background:#222;box-shadow:0 5px 0 #222,0 10px 0 #222}#spectaql .sidebar-open-button .sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);white-space:nowrap;border:0}#spectaql .close-button{display:block}#spectaql .close-button .sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);white-space:nowrap;border:0}@media (min-width:48em){#spectaql .close-button{display:none}}#spectaql .drawer-overlay{display:none;position:absolute;top:0;left:0;bottom:0;right:0;background:rgba(0,0,0,0)}@media (min-width:48em){#spectaql .drawer-overlay{display:none!important}}#spectaql #nav{display:flex;flex-direction:column;max-height:calc(100vh - 0px);padding:0 20px;padding-bottom:20px;position:sticky;top:0;overflow:auto}#spectaql #logo{margin-right:auto}#spectaql #logo img{display:block;width:100%;max-width:100%}#spectaql .nav-group-items,#spectaql .nav-group-section-items{padding:0;margin:0}#spectaql .nav-group-items>li,#spectaql .nav-group-section-items>li{list-style:none}#spectaql .nav-group-items .nav-group-section-title,#spectaql .nav-group-items>li,#spectaql .nav-group-section-items .nav-group-section-title,#spectaql .nav-group-section-items>li{overflow:hidden;text-overflow:ellipsis}#spectaql .nav-group-section-items{display:none}#spectaql .nav-scroll-expand .nav-group-section-items{display:block}#spectaql #docs{position:relative;margin:0 auto;min-width:100px;max-width:88em;flex-grow:1;flex-shrink:1;padding:20px}@media (min-width:48em){#spectaql .doc-row{display:flex;flex-wrap:wrap}}#spectaql .doc-row .doc-copy,#spectaql .doc-row .doc-examples{width:100%}@media (min-width:48em){#spectaql .doc-row .doc-copy,#spectaql .doc-row .doc-examples{width:50%}}@media (min-width:48em){#spectaql .doc-row .doc-copy{padding-right:20px}}@media (min-width:48em){#spectaql .doc-row .doc-examples{padding-left:20px}}.hljs{display:block;overflow-x:auto;padding:.5em;background:#23241f}.hljs,.hljs-subst,.hljs-tag{color:#f8f8f2}.hljs-emphasis,.hljs-strong{color:#a8a8a2}.hljs-bullet,.hljs-link,.hljs-literal,.hljs-number,.hljs-quote,.hljs-regexp{color:#ae81ff}.hljs-code,.hljs-section,.hljs-selector-class,.hljs-title{color:#a6e22e}.hljs-strong{font-weight:700}.hljs-emphasis{font-style:italic}.hljs-attr,.hljs-keyword,.hljs-name,.hljs-selector-tag{color:#f92672}.hljs-attribute,.hljs-symbol{color:#66d9ef}.hljs-class .hljs-title,.hljs-params{color:#f8f8f2}.hljs-addition,.hljs-built_in,.hljs-builtin-name,.hljs-selector-attr,.hljs-selector-id,.hljs-selector-pseudo,.hljs-string,.hljs-template-variable,.hljs-type,.hljs-variable{color:#e6db74}.hljs-comment,.hljs-deletion,.hljs-meta{color:#75715e}#spectaql{font-family:Barlow,"Open Sans",serif;font-size:14px;line-height:1.6;background:#fff;color:#222}@media (min-width:32em){#spectaql{font-size:16px}}#spectaql a{color:#0298bf;text-decoration:none}#spectaql a:hover{color:#0182a2}#spectaql a:active,#spectaql a:focus{color:#0298bf}#spectaql code{font-size:.875em;font-family:Consolas,Monaco,Andale Mono,Ubuntu Mono,monospace}#spectaql pre{color:#fff}#spectaql pre code{background:#222}#spectaql pre code,#spectaql pre code.hljs{font-size:.82em;line-height:1.4;padding:15px 20px}#spectaql .doc-heading{line-height:1.2;font-size:2.25em;margin-top:10px}@media (min-width:48em){#spectaql .doc-heading{margin-top:-10px}}#spectaql .close-button{background:0 0;border:none;padding:5px;font-size:16px;font-weight:700;color:#222}#spectaql #introduction{margin-bottom:60px}#spectaql #introduction .example-section:not(.example-section-is-code){margin-bottom:20px}#spectaql #introduction .example-section:not(.example-section-is-code) h5,#spectaql #introduction .example-section:not(.example-section-is-code) p{margin:0;font-size:1em}#spectaql #docs,#spectaql #mobile-navbar,#spectaql #sidebar{padding-top:20px;padding-bottom:20px}@media (min-width:32em){#spectaql #docs,#spectaql #mobile-navbar,#spectaql #sidebar{padding-top:30px;padding-bottom:30px}}@media (min-width:48em){#spectaql #docs,#spectaql #mobile-navbar,#spectaql #sidebar{padding-top:40px;padding-bottom:40px}}#spectaql #docs,#spectaql #mobile-navbar,#spectaql #nav,#spectaql .sidebar-top-container{padding-left:20px;padding-right:20px}@media (min-width:32em){#spectaql #docs,#spectaql #mobile-navbar,#spectaql #nav,#spectaql .sidebar-top-container{padding-left:30px;padding-right:30px}}@media (min-width:48em){#spectaql #docs,#spectaql #mobile-navbar,#spectaql #nav,#spectaql .sidebar-top-container{padding-left:50px;padding-right:50px}}#spectaql #sidebar{padding-bottom:0;background:#fff}#spectaql #sidebar a{color:#222}#spectaql #sidebar a.nav-scroll-active,#spectaql #sidebar a:hover{font-weight:700}#spectaql #sidebar a.nav-scroll-active{color:#222}#spectaql #sidebar a:hover{color:#0182a2}@media (min-width:48em){#spectaql #sidebar{border-right:2px solid #d8d8d8}}#spectaql #mobile-navbar{background:#fff;margin-top:-20px;margin-left:-20px;margin-right:-20px}@media (min-width:32em){#spectaql #mobile-navbar{margin-top:-30px;margin-left:-30px;margin-right:-30px}}#spectaql #mobile-navbar .sidebar-open-button::after{display:block;content:"All Topics";margin-left:10px;color:#222}#spectaql #nav .nav-group{margin-top:20px}#spectaql #nav .nav-group li{margin-bottom:5px}#spectaql #nav .nav-group-title{font-size:.875em;font-weight:400;margin:0 0 6px 0;color:#999}#spectaql #nav .nav-group-section-title{font-size:inherit;margin:0;margin-bottom:5px;font-weight:400}#spectaql #nav .nav-group-section-items{margin-left:.75em}#spectaql .definition,#spectaql .operation{margin-bottom:60px}#spectaql .definition .definition-heading,#spectaql .definition .operation-heading,#spectaql .operation .definition-heading,#spectaql .operation .operation-heading{font-size:1.72em}#spectaql .definition .definition-heading code,#spectaql .definition .operation-heading code,#spectaql .operation .definition-heading code,#spectaql .operation .operation-heading code{font-family:inherit;font-size:inherit;font-weight:inherit}@media (min-width:32em){#spectaql .definition .definition-heading,#spectaql .definition .operation-heading,#spectaql .operation .definition-heading,#spectaql .operation .operation-heading{font-size:2.25em}}#spectaql .definition-group-name,#spectaql .group-heading,#spectaql .operation-group-name{border-top:2px solid #d8d8d8;padding-top:3px;color:#999;font-size:inherit;font-weight:inherit}#spectaql .definition-group-name a,#spectaql .group-heading a,#spectaql .operation-group-name a{color:#999}#spectaql .definition-group-name a:hover,#spectaql .group-heading a:hover,#spectaql .operation-group-name a:hover{font-weight:700}#spectaql .doc-examples{margin-top:20px}#spectaql .doc-examples .example-heading{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);white-space:nowrap;border:0}#spectaql .doc-examples .example-section-is-code h5{color:#999;text-transform:uppercase;background:#000;font-size:.75em;font-weight:700;padding:.6em 0 .6em 20px;margin:0;opacity:1}@media (min-width:48em){#spectaql .doc-examples{margin-top:0}}#spectaql .doc-copy p{margin:0 0 20px 0}#spectaql .doc-copy p:last-child{margin-bottom:0}#spectaql .doc-copy table tr th{font-weight:400;border-bottom:2px solid #d8d8d8}#spectaql .doc-copy table tr td{border-bottom:1px solid #e0e0e0}#spectaql .doc-copy table tr.row-has-field-arguments td,#spectaql .doc-copy table tr:last-child td{border-bottom:none}#spectaql .doc-copy table tr td,#spectaql .doc-copy table tr th{padding:5px}#spectaql .doc-copy table tr td:first-child,#spectaql .doc-copy table tr th:first-child{padding-left:0}#spectaql .doc-copy table tr td:last-child,#spectaql .doc-copy table tr th:last-child{padding-right:0}#spectaql .doc-copy .doc-copy-section{margin-bottom:30px}#spectaql .doc-copy .doc-copy-section>h5{margin:0 0 5px 0;font-size:inherit;font-weight:inherit;color:#999}#spectaql .doc-copy .definition-description>h5,#spectaql .doc-copy .definition-properties>h5,#spectaql .doc-copy .operation-description>h5{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);white-space:nowrap;border:0}#spectaql .field-arguments{font-size:.875em;background-color:#fafbfc;border:1px solid #e0e0e0;padding:10px;margin-bottom:5px}#spectaql .field-arguments p{margin:10px 0 0 0}#spectaql .field-arguments h5.field-arguments-heading{margin:0;padding:0 0 10px 0;font-weight:inherit;color:#999}#spectaql .field-arguments .field-argument{border-top:1px #e0e0e0 solid;padding:10px 0}#spectaql .field-arguments .field-argument:last-child{padding-bottom:0}#spectaql .field-arguments .field-argument-name{margin:0;font-size:inherit;font-weight:inherit}#spectaql .deprecation-reason{word-break:break-word}#spectaql .deprecation-reason::before{display:inline;content:"Deprecated";padding:2px 5px;margin-right:5px;background:#fed7d8;color:#c60609;font-weight:700;font-size:.875em} \ No newline at end of file From fdfbc7504654a3f5ddccc72cf16742a6db42f816 Mon Sep 17 00:00:00 2001 From: Dima Shevtsov Date: Mon, 3 Feb 2025 14:55:04 -0600 Subject: [PATCH 03/11] Delete unused artifacts since they were embedded in the html file --- static/graphql-api/javascripts/spectaql.min.js | 1 - static/graphql-api/stylesheets/spectaql.min.css | 1 - 2 files changed, 2 deletions(-) delete mode 100644 static/graphql-api/javascripts/spectaql.min.js delete mode 100644 static/graphql-api/stylesheets/spectaql.min.css diff --git a/static/graphql-api/javascripts/spectaql.min.js b/static/graphql-api/javascripts/spectaql.min.js deleted file mode 100644 index 0b7aea058..000000000 --- a/static/graphql-api/javascripts/spectaql.min.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";function scrollSpy(){var c=5,e=document.querySelector("html"),l=(e&&(e=window.getComputedStyle(e).scrollPaddingTop)&&"string"==typeof e&&"auto"!==e&&e.endsWith("px")&&(c+=parseInt(e.split("px")[0])),"nav-scroll-active"),i=null,d=[];function t(){i=null;var e=document.querySelectorAll("[data-traverse-target]");Array.prototype.forEach.call(e,function(e){d.push({id:e.id,top:e.offsetTop})})}var n=debounce(function(){t(),o()},500),o=debounce(function(){var e,t,n,o,r=function(e){for(var t=e+c,n=0;n=d[n].top&&(!o||t{toggleMenu(),scrollSpy()}); \ No newline at end of file diff --git a/static/graphql-api/stylesheets/spectaql.min.css b/static/graphql-api/stylesheets/spectaql.min.css deleted file mode 100644 index 697a02b3e..000000000 --- a/static/graphql-api/stylesheets/spectaql.min.css +++ /dev/null @@ -1 +0,0 @@ -html{scroll-padding-top:10px}#spectaql{padding:0;margin:0}#spectaql pre{overflow:auto;margin-top:0;margin-bottom:20px}#spectaql pre code{display:block;background:#ccc}#spectaql table{width:100%;table-layout:fixed;text-align:left;border-collapse:collapse}#spectaql table td,#spectaql table th{margin:0;padding:0}#spectaql #introduction .example-section>*,#spectaql .definition-heading,#spectaql .doc-heading,#spectaql .introduction-item-title,#spectaql .operation-heading{overflow:hidden;text-overflow:ellipsis}#spectaql #page{display:flex}#spectaql #page *{box-sizing:border-box}#spectaql #page.drawer-open #sidebar{z-index:1000;transform:translateX(0)}#spectaql #page.drawer-open .drawer-overlay{display:block;background:rgba(0,0,0,.5);z-index:10}#spectaql #sidebar{position:fixed;min-width:250px;max-width:250px;flex-shrink:0;transition:transform .2s ease-out;transform:translateX(-100%);z-index:10;padding-top:20px;background:#fff}@media (min-width:48em){#spectaql #sidebar{position:relative;transform:none}}@media (min-width:64em){#spectaql #sidebar{min-width:300px;max-width:300px}}#spectaql .sidebar-top-container{display:flex;align-items:center;padding:0 20px}#spectaql #mobile-navbar{display:flex;align-items:center;position:sticky;top:0}@media (min-width:48em){#spectaql #mobile-navbar{display:none}}#spectaql .sidebar-open-button{display:flex;align-items:flex-start;margin:0;padding:0;border:none;background:0 0}#spectaql .sidebar-open-button .hamburger{width:16px;height:14px;cursor:pointer}#spectaql .sidebar-open-button .hamburger::after{display:block;content:"";height:2px;background:#222;box-shadow:0 5px 0 #222,0 10px 0 #222}#spectaql .sidebar-open-button .sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);white-space:nowrap;border:0}#spectaql .close-button{display:block}#spectaql .close-button .sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);white-space:nowrap;border:0}@media (min-width:48em){#spectaql .close-button{display:none}}#spectaql .drawer-overlay{display:none;position:absolute;top:0;left:0;bottom:0;right:0;background:rgba(0,0,0,0)}@media (min-width:48em){#spectaql .drawer-overlay{display:none!important}}#spectaql #nav{display:flex;flex-direction:column;max-height:calc(100vh - 0px);padding:0 20px;padding-bottom:20px;position:sticky;top:0;overflow:auto}#spectaql #logo{margin-right:auto}#spectaql #logo img{display:block;width:100%;max-width:100%}#spectaql .nav-group-items,#spectaql .nav-group-section-items{padding:0;margin:0}#spectaql .nav-group-items>li,#spectaql .nav-group-section-items>li{list-style:none}#spectaql .nav-group-items .nav-group-section-title,#spectaql .nav-group-items>li,#spectaql .nav-group-section-items .nav-group-section-title,#spectaql .nav-group-section-items>li{overflow:hidden;text-overflow:ellipsis}#spectaql .nav-group-section-items{display:none}#spectaql .nav-scroll-expand .nav-group-section-items{display:block}#spectaql #docs{position:relative;margin:0 auto;min-width:100px;max-width:88em;flex-grow:1;flex-shrink:1;padding:20px}@media (min-width:48em){#spectaql .doc-row{display:flex;flex-wrap:wrap}}#spectaql .doc-row .doc-copy,#spectaql .doc-row .doc-examples{width:100%}@media (min-width:48em){#spectaql .doc-row .doc-copy,#spectaql .doc-row .doc-examples{width:50%}}@media (min-width:48em){#spectaql .doc-row .doc-copy{padding-right:20px}}@media (min-width:48em){#spectaql .doc-row .doc-examples{padding-left:20px}}.hljs{display:block;overflow-x:auto;padding:.5em;background:#23241f}.hljs,.hljs-subst,.hljs-tag{color:#f8f8f2}.hljs-emphasis,.hljs-strong{color:#a8a8a2}.hljs-bullet,.hljs-link,.hljs-literal,.hljs-number,.hljs-quote,.hljs-regexp{color:#ae81ff}.hljs-code,.hljs-section,.hljs-selector-class,.hljs-title{color:#a6e22e}.hljs-strong{font-weight:700}.hljs-emphasis{font-style:italic}.hljs-attr,.hljs-keyword,.hljs-name,.hljs-selector-tag{color:#f92672}.hljs-attribute,.hljs-symbol{color:#66d9ef}.hljs-class .hljs-title,.hljs-params{color:#f8f8f2}.hljs-addition,.hljs-built_in,.hljs-builtin-name,.hljs-selector-attr,.hljs-selector-id,.hljs-selector-pseudo,.hljs-string,.hljs-template-variable,.hljs-type,.hljs-variable{color:#e6db74}.hljs-comment,.hljs-deletion,.hljs-meta{color:#75715e}#spectaql{font-family:-apple-system,BlinkMacSystemFont,system-ui,"Segoe UI",Roboto,Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";font-size:14px;line-height:1.6;background:#fff;color:#222}@media (min-width:32em){#spectaql{font-size:16px}}#spectaql a{color:#0298bf;text-decoration:none}#spectaql a:hover{color:#0182a2}#spectaql a:active,#spectaql a:focus{color:#0298bf}#spectaql code{font-size:.875em;font-family:Consolas,Monaco,Andale Mono,Ubuntu Mono,monospace}#spectaql pre{color:#fff}#spectaql pre code{background:#222}#spectaql pre code,#spectaql pre code.hljs{font-size:.82em;line-height:1.4;padding:15px 20px}#spectaql .doc-heading{line-height:1.2;font-size:2.25em;margin-top:10px}@media (min-width:48em){#spectaql .doc-heading{margin-top:-10px}}#spectaql .close-button{background:0 0;border:none;padding:5px;font-size:16px;font-weight:700;color:#222}#spectaql #introduction{margin-bottom:60px}#spectaql #introduction .example-section:not(.example-section-is-code){margin-bottom:20px}#spectaql #introduction .example-section:not(.example-section-is-code) h5,#spectaql #introduction .example-section:not(.example-section-is-code) p{margin:0;font-size:1em}#spectaql #docs,#spectaql #mobile-navbar,#spectaql #sidebar{padding-top:20px;padding-bottom:20px}@media (min-width:32em){#spectaql #docs,#spectaql #mobile-navbar,#spectaql #sidebar{padding-top:30px;padding-bottom:30px}}@media (min-width:48em){#spectaql #docs,#spectaql #mobile-navbar,#spectaql #sidebar{padding-top:40px;padding-bottom:40px}}#spectaql #docs,#spectaql #mobile-navbar,#spectaql #nav,#spectaql .sidebar-top-container{padding-left:20px;padding-right:20px}@media (min-width:32em){#spectaql #docs,#spectaql #mobile-navbar,#spectaql #nav,#spectaql .sidebar-top-container{padding-left:30px;padding-right:30px}}@media (min-width:48em){#spectaql #docs,#spectaql #mobile-navbar,#spectaql #nav,#spectaql .sidebar-top-container{padding-left:50px;padding-right:50px}}#spectaql #sidebar{padding-bottom:0;background:#fff}#spectaql #sidebar a{color:#222}#spectaql #sidebar a.nav-scroll-active,#spectaql #sidebar a:hover{font-weight:700}#spectaql #sidebar a.nav-scroll-active{color:#222}#spectaql #sidebar a:hover{color:#0182a2}@media (min-width:48em){#spectaql #sidebar{border-right:2px solid #d8d8d8}}#spectaql #mobile-navbar{background:#fff;margin-top:-20px;margin-left:-20px;margin-right:-20px}@media (min-width:32em){#spectaql #mobile-navbar{margin-top:-30px;margin-left:-30px;margin-right:-30px}}#spectaql #mobile-navbar .sidebar-open-button::after{display:block;content:"All Topics";margin-left:10px;color:#222}#spectaql #nav .nav-group{margin-top:20px}#spectaql #nav .nav-group li{margin-bottom:5px}#spectaql #nav .nav-group-title{font-size:.875em;font-weight:400;margin:0 0 6px 0;color:#999}#spectaql #nav .nav-group-section-title{font-size:inherit;margin:0;margin-bottom:5px;font-weight:400}#spectaql #nav .nav-group-section-items{margin-left:.75em}#spectaql .definition,#spectaql .operation{margin-bottom:60px}#spectaql .definition .definition-heading,#spectaql .definition .operation-heading,#spectaql .operation .definition-heading,#spectaql .operation .operation-heading{font-size:1.72em}#spectaql .definition .definition-heading code,#spectaql .definition .operation-heading code,#spectaql .operation .definition-heading code,#spectaql .operation .operation-heading code{font-family:inherit;font-size:inherit;font-weight:inherit}@media (min-width:32em){#spectaql .definition .definition-heading,#spectaql .definition .operation-heading,#spectaql .operation .definition-heading,#spectaql .operation .operation-heading{font-size:2.25em}}#spectaql .definition-group-name,#spectaql .group-heading,#spectaql .operation-group-name{border-top:2px solid #d8d8d8;padding-top:3px;color:#999;font-size:inherit;font-weight:inherit}#spectaql .definition-group-name a,#spectaql .group-heading a,#spectaql .operation-group-name a{color:#999}#spectaql .definition-group-name a:hover,#spectaql .group-heading a:hover,#spectaql .operation-group-name a:hover{font-weight:700}#spectaql .doc-examples{margin-top:20px}#spectaql .doc-examples .example-heading{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);white-space:nowrap;border:0}#spectaql .doc-examples .example-section-is-code h5{color:#999;text-transform:uppercase;background:#000;font-size:.75em;font-weight:700;padding:.6em 0 .6em 20px;margin:0;opacity:1}@media (min-width:48em){#spectaql .doc-examples{margin-top:0}}#spectaql .doc-copy p{margin:0 0 20px 0}#spectaql .doc-copy p:last-child{margin-bottom:0}#spectaql .doc-copy table tr th{font-weight:400;border-bottom:2px solid #d8d8d8}#spectaql .doc-copy table tr td{border-bottom:1px solid #e0e0e0}#spectaql .doc-copy table tr.row-has-field-arguments td,#spectaql .doc-copy table tr:last-child td{border-bottom:none}#spectaql .doc-copy table tr td,#spectaql .doc-copy table tr th{padding:5px}#spectaql .doc-copy table tr td:first-child,#spectaql .doc-copy table tr th:first-child{padding-left:0}#spectaql .doc-copy table tr td:last-child,#spectaql .doc-copy table tr th:last-child{padding-right:0}#spectaql .doc-copy .doc-copy-section{margin-bottom:30px}#spectaql .doc-copy .doc-copy-section>h5{margin:0 0 5px 0;font-size:inherit;font-weight:inherit;color:#999}#spectaql .doc-copy .definition-description>h5,#spectaql .doc-copy .definition-properties>h5,#spectaql .doc-copy .operation-description>h5{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);white-space:nowrap;border:0}#spectaql .field-arguments{font-size:.875em;background-color:#fafbfc;border:1px solid #e0e0e0;padding:10px;margin-bottom:5px}#spectaql .field-arguments p{margin:10px 0 0 0}#spectaql .field-arguments h5.field-arguments-heading{margin:0;padding:0 0 10px 0;font-weight:inherit;color:#999}#spectaql .field-arguments .field-argument{border-top:1px #e0e0e0 solid;padding:10px 0}#spectaql .field-arguments .field-argument:last-child{padding-bottom:0}#spectaql .field-arguments .field-argument-name{margin:0;font-size:inherit;font-weight:inherit}#spectaql .deprecation-reason{word-break:break-word}#spectaql .deprecation-reason::before{display:inline;content:"Deprecated";padding:2px 5px;margin-right:5px;background:#fed7d8;color:#c60609;font-weight:700;font-size:.875em} \ No newline at end of file From b3d5deb9965f1c8d334863b903644f43ed32afa8 Mon Sep 17 00:00:00 2001 From: Dima Shevtsov Date: Mon, 3 Feb 2025 16:56:16 -0600 Subject: [PATCH 04/11] Add logo and favicon --- .../views/partials/layout/page.hbs | 29 + spectaql/config.yml | 5 +- static/graphql-api/index.html | 3307 ++++++++--------- 3 files changed, 1682 insertions(+), 1659 deletions(-) create mode 100644 spectaql/comdox-theme/views/partials/layout/page.hbs diff --git a/spectaql/comdox-theme/views/partials/layout/page.hbs b/spectaql/comdox-theme/views/partials/layout/page.hbs new file mode 100644 index 000000000..df180f858 --- /dev/null +++ b/spectaql/comdox-theme/views/partials/layout/page.hbs @@ -0,0 +1,29 @@ +
+ {{! DO THE NAVIGATION }} + + +
+ {{>layout/nav/mobile-navbar}} + {{>layout/content/main}} +
+
+
diff --git a/spectaql/config.yml b/spectaql/config.yml index 58cc15268..9f84837cf 100644 --- a/spectaql/config.yml +++ b/spectaql/config.yml @@ -31,7 +31,7 @@ spectaql: # Optional URL to an image to use in your logo. This string will be provided as-is # to the HTML output. Should not be used with logoFile and its related options as # this will take precedence over the logoFile. - # logoUrl: https://yoursite.com/images/logo.png + logoUrl: https://developer.adobe.com/shared/images/adobe-social-share.png # Control the height of your logo here. Can be useful if your logo is SVG or an # inappropriate size. # @@ -51,7 +51,7 @@ spectaql: # Optional URL to an image to use in your favicon. This string will be provided as-is # to the HTML output. Should not be used with faviconFile and its related options as # this will take precedence over the faviconFile. - # faviconUrl: https://yoursite.com/images/favicon.png + faviconUrl: https://www.adobe.com/favicon.ico # Optional string specifying a path to a theme directory to use for your build. # @@ -454,4 +454,3 @@ info: # If not using introspection.url OR servers[], you need to provide x-url # x-url: https://yoursite.com/graphql - \ No newline at end of file diff --git a/static/graphql-api/index.html b/static/graphql-api/index.html index ab3a2acf1..0bdff9503 100644 --- a/static/graphql-api/index.html +++ b/static/graphql-api/index.html @@ -3,6 +3,7 @@ + GraphQL API @@ -12,6 +13,9 @@