Mutations

acceptCompanyInvitation

Accept invitation to the company.

Response: CompanyInvitationOutput

Arguments

Example

Query

mutation acceptCompanyInvitation($input: CompanyInvitationInput!) {
  acceptCompanyInvitation(input: $input) {
    success
  }
}

Variables

{"input": CompanyInvitationInput}

Response

{"data": {"acceptCompanyInvitation": {"success": true}}}

acceptNegotiableQuoteTemplate

Update an existing negotiable quote template.

Response: NegotiableQuoteTemplate

Arguments

Example

Query

mutation acceptNegotiableQuoteTemplate($input: AcceptNegotiableQuoteTemplateInput!) {
  acceptNegotiableQuoteTemplate(input: $input) {
    buyer {
      ...NegotiableQuoteUserFragment
    }
    comments {
      ...NegotiableQuoteCommentFragment
    }
    expiration_date
    history {
      ...NegotiableQuoteHistoryEntryFragment
    }
    is_min_max_qty_used
    is_virtual
    items {
      ...CartItemInterfaceFragment
    }
    max_order_commitment
    min_order_commitment
    name
    notifications {
      ...QuoteTemplateNotificationMessageFragment
    }
    prices {
      ...CartPricesFragment
    }
    reference_document_links {
      ...NegotiableQuoteReferenceDocumentLinkFragment
    }
    shipping_addresses {
      ...NegotiableQuoteShippingAddressFragment
    }
    status
    template_id
    total_quantity
  }
}

Variables

{"input": AcceptNegotiableQuoteTemplateInput}

Response

{
  "data": {
    "acceptNegotiableQuoteTemplate": {
      "buyer": NegotiableQuoteUser,
      "comments": [NegotiableQuoteComment],
      "expiration_date": "xyz789",
      "history": [NegotiableQuoteHistoryEntry],
      "is_min_max_qty_used": true,
      "is_virtual": true,
      "items": [CartItemInterface],
      "max_order_commitment": 123,
      "min_order_commitment": 987,
      "name": "xyz789",
      "notifications": [QuoteTemplateNotificationMessage],
      "prices": CartPrices,
      "reference_document_links": [
        NegotiableQuoteReferenceDocumentLink
      ],
      "shipping_addresses": [
        NegotiableQuoteShippingAddress
      ],
      "status": "xyz789",
      "template_id": "4",
      "total_quantity": 987.65
    }
  }
}

addBundleProductsToCart

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

Response: AddBundleProductsToCartOutput

Arguments

Example

Query

mutation addBundleProductsToCart($input: AddBundleProductsToCartInput) {
  addBundleProductsToCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}

Variables

{"input": AddBundleProductsToCartInput}

Response

{"data": {"addBundleProductsToCart": {"cart": Cart}}}

addConfigurableProductsToCart

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

Response: AddConfigurableProductsToCartOutput

Arguments

Example

Query

mutation addConfigurableProductsToCart($input: AddConfigurableProductsToCartInput) {
  addConfigurableProductsToCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}

Variables

{"input": AddConfigurableProductsToCartInput}

Response

{
  "data": {
    "addConfigurableProductsToCart": {"cart": Cart}
  }
}

addDownloadableProductsToCart

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

Response: AddDownloadableProductsToCartOutput

Arguments

Example

Query

mutation addDownloadableProductsToCart($input: AddDownloadableProductsToCartInput) {
  addDownloadableProductsToCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}

Variables

{"input": AddDownloadableProductsToCartInput}

Response

{
  "data": {
    "addDownloadableProductsToCart": {"cart": Cart}
  }
}

addGiftRegistryRegistrants

Add registrants to the specified gift registry.

Response: AddGiftRegistryRegistrantsOutput

Arguments

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

addProductsToCart

Add any type of product to the cart.

Response: AddProductsToCartOutput

Arguments

Example

Query

mutation addProductsToCart(
  $cartId: String!,
  $cartItems: [CartItemInput!]!
) {
  addProductsToCart(
    cartId: $cartId,
    cartItems: $cartItems
  ) {
    cart {
      ...CartFragment
    }
    user_errors {
      ...ErrorFragment
    }
  }
}

Variables

{
  "cartId": "abc123",
  "cartItems": [CartItemInput]
}

Response

{
  "data": {
    "addProductsToCart": {
      "cart": Cart,
      "user_errors": [Error]
    }
  }
}

addProductsToCompareList

Add products to the specified compare list.

Response: CompareList

Arguments

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": 987,
      "items": [ComparableItem],
      "uid": "4"
    }
  }
}

addProductsToRequisitionList

Add items to the specified requisition list.

Response: AddProductsToRequisitionListOutput

Arguments

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

addProductsToWishlist

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

Response: AddProductsToWishlistOutput

Arguments

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

addPurchaseOrderComment

Add a comment to an existing purchase order.

Response: AddPurchaseOrderCommentOutput

Arguments

Example

Query

mutation addPurchaseOrderComment($input: AddPurchaseOrderCommentInput!) {
  addPurchaseOrderComment(input: $input) {
    comment {
      ...PurchaseOrderCommentFragment
    }
  }
}

Variables

{"input": AddPurchaseOrderCommentInput}

Response

{
  "data": {
    "addPurchaseOrderComment": {
      "comment": PurchaseOrderComment
    }
  }
}

addPurchaseOrderItemsToCart

Add purchase order items to the shopping cart.

Response: AddProductsToCartOutput

Arguments

Example

Query

mutation addPurchaseOrderItemsToCart($input: AddPurchaseOrderItemsToCartInput!) {
  addPurchaseOrderItemsToCart(input: $input) {
    cart {
      ...CartFragment
    }
    user_errors {
      ...ErrorFragment
    }
  }
}

Variables

{"input": AddPurchaseOrderItemsToCartInput}

Response

{
  "data": {
    "addPurchaseOrderItemsToCart": {
      "cart": Cart,
      "user_errors": [Error]
    }
  }
}

addRequisitionListItemsToCart

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

Response: AddRequisitionListItemsToCartOutput

Arguments

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

addReturnComment

Add a comment to an existing return.

Response: AddReturnCommentOutput

Arguments

Example

Query

mutation addReturnComment($input: AddReturnCommentInput!) {
  addReturnComment(input: $input) {
    return {
      ...ReturnFragment
    }
  }
}

Variables

{"input": AddReturnCommentInput}

Response

{"data": {"addReturnComment": {"return": Return}}}

addReturnTracking

Add tracking information to the return.

Response: AddReturnTrackingOutput

Arguments

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

addSimpleProductsToCart

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

Response: AddSimpleProductsToCartOutput

Arguments

Example

Query

mutation addSimpleProductsToCart($input: AddSimpleProductsToCartInput) {
  addSimpleProductsToCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}

Variables

{"input": AddSimpleProductsToCartInput}

Response

{"data": {"addSimpleProductsToCart": {"cart": Cart}}}

addVirtualProductsToCart

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

Response: AddVirtualProductsToCartOutput

Arguments

Example

Query

mutation addVirtualProductsToCart($input: AddVirtualProductsToCartInput) {
  addVirtualProductsToCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}

Variables

{"input": AddVirtualProductsToCartInput}

Response

{"data": {"addVirtualProductsToCart": {"cart": Cart}}}

addWishlistItemsToCart

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

Response: AddWishlistItemsToCartOutput

Arguments

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

applyCouponToCart

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

Response: ApplyCouponToCartOutput

Arguments

Example

Query

mutation applyCouponToCart($input: ApplyCouponToCartInput) {
  applyCouponToCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}

Variables

{"input": ApplyCouponToCartInput}

Response

{"data": {"applyCouponToCart": {"cart": Cart}}}

applyCouponsToCart

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

Response: ApplyCouponToCartOutput

Arguments

Example

Query

mutation applyCouponsToCart($input: ApplyCouponsToCartInput) {
  applyCouponsToCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}

Variables

{"input": ApplyCouponsToCartInput}

Response

{"data": {"applyCouponsToCart": {"cart": Cart}}}

applyGiftCardToCart

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

Response: ApplyGiftCardToCartOutput

Arguments

Example

Query

mutation applyGiftCardToCart($input: ApplyGiftCardToCartInput) {
  applyGiftCardToCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}

Variables

{"input": ApplyGiftCardToCartInput}

Response

{"data": {"applyGiftCardToCart": {"cart": Cart}}}

applyRewardPointsToCart

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

Response: ApplyRewardPointsToCartOutput

Arguments

Example

Query

mutation applyRewardPointsToCart($cartId: ID!) {
  applyRewardPointsToCart(cartId: $cartId) {
    cart {
      ...CartFragment
    }
  }
}

Variables

{"cartId": 4}

Response

{"data": {"applyRewardPointsToCart": {"cart": Cart}}}

applyStoreCreditToCart

Apply store credit to the specified cart.

Response: ApplyStoreCreditToCartOutput

Arguments

Example

Query

mutation applyStoreCreditToCart($input: ApplyStoreCreditToCartInput!) {
  applyStoreCreditToCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}

Variables

{"input": ApplyStoreCreditToCartInput}

Response

{"data": {"applyStoreCreditToCart": {"cart": Cart}}}

approvePurchaseOrders

Approve purchase orders.

Response: PurchaseOrdersActionOutput

Arguments

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

assignCompareListToCustomer

Assign the specified compare list to the logged in customer.

Response: AssignCompareListToCustomerOutput

Arguments

Example

Query

mutation assignCompareListToCustomer($uid: ID!) {
  assignCompareListToCustomer(uid: $uid) {
    compare_list {
      ...CompareListFragment
    }
    result
  }
}

Variables

{"uid": 4}

Response

{
  "data": {
    "assignCompareListToCustomer": {
      "compare_list": CompareList,
      "result": true
    }
  }
}

assignCustomerToGuestCart

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

Response: Cart!

Arguments

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
    }
    itemsV2 {
      ...CartItemsFragment
    }
    prices {
      ...CartPricesFragment
    }
    printed_card_included
    rules {
      ...CartRuleFragment
    }
    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],
      "itemsV2": CartItems,
      "prices": CartPrices,
      "printed_card_included": false,
      "rules": [CartRule],
      "selected_payment_method": SelectedPaymentMethod,
      "shipping_addresses": [ShippingCartAddress],
      "total_quantity": 987.65
    }
  }
}

cancelNegotiableQuoteTemplate

Cancel a negotiable quote template

Response: NegotiableQuoteTemplate

Arguments

Example

Query

mutation cancelNegotiableQuoteTemplate($input: CancelNegotiableQuoteTemplateInput!) {
  cancelNegotiableQuoteTemplate(input: $input) {
    buyer {
      ...NegotiableQuoteUserFragment
    }
    comments {
      ...NegotiableQuoteCommentFragment
    }
    expiration_date
    history {
      ...NegotiableQuoteHistoryEntryFragment
    }
    is_min_max_qty_used
    is_virtual
    items {
      ...CartItemInterfaceFragment
    }
    max_order_commitment
    min_order_commitment
    name
    notifications {
      ...QuoteTemplateNotificationMessageFragment
    }
    prices {
      ...CartPricesFragment
    }
    reference_document_links {
      ...NegotiableQuoteReferenceDocumentLinkFragment
    }
    shipping_addresses {
      ...NegotiableQuoteShippingAddressFragment
    }
    status
    template_id
    total_quantity
  }
}

Variables

{"input": CancelNegotiableQuoteTemplateInput}

Response

{
  "data": {
    "cancelNegotiableQuoteTemplate": {
      "buyer": NegotiableQuoteUser,
      "comments": [NegotiableQuoteComment],
      "expiration_date": "xyz789",
      "history": [NegotiableQuoteHistoryEntry],
      "is_min_max_qty_used": false,
      "is_virtual": false,
      "items": [CartItemInterface],
      "max_order_commitment": 987,
      "min_order_commitment": 123,
      "name": "abc123",
      "notifications": [QuoteTemplateNotificationMessage],
      "prices": CartPrices,
      "reference_document_links": [
        NegotiableQuoteReferenceDocumentLink
      ],
      "shipping_addresses": [
        NegotiableQuoteShippingAddress
      ],
      "status": "xyz789",
      "template_id": 4,
      "total_quantity": 123.45
    }
  }
}

cancelOrder

Cancel the specified customer order.

Response: CancelOrderOutput

Arguments

Example

Query

mutation cancelOrder($input: CancelOrderInput!) {
  cancelOrder(input: $input) {
    error
    errorV2 {
      ...CancelOrderErrorFragment
    }
    order {
      ...CustomerOrderFragment
    }
  }
}

Variables

{"input": CancelOrderInput}

Response

{
  "data": {
    "cancelOrder": {
      "error": "abc123",
      "errorV2": CancelOrderError,
      "order": CustomerOrder
    }
  }
}

cancelPurchaseOrders

Cancel purchase orders.

Response: PurchaseOrdersActionOutput

Arguments

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

changeCustomerPassword

Change the password for the logged-in customer.

Response: Customer

Arguments

Example

Query

mutation changeCustomerPassword(
  $currentPassword: String!,
  $newPassword: String!
) {
  changeCustomerPassword(
    currentPassword: $currentPassword,
    newPassword: $newPassword
  ) {
    addresses {
      ...CustomerAddressFragment
    }
    addressesV2 {
      ...CustomerAddressesFragment
    }
    allow_remote_shopping_assistance
    companies {
      ...UserCompaniesOutputFragment
    }
    compare_list {
      ...CompareListFragment
    }
    confirmation_status
    created_at
    custom_attributes {
      ...AttributeValueInterfaceFragment
    }
    date_of_birth
    default_billing
    default_shipping
    dob
    email
    firstname
    gender
    gift_registries {
      ...GiftRegistryFragment
    }
    gift_registry {
      ...GiftRegistryFragment
    }
    group {
      ...CustomerGroupFragment
    }
    group_id
    id
    is_subscribed
    job_title
    lastname
    middlename
    orders {
      ...CustomerOrdersFragment
    }
    prefix
    purchase_order {
      ...PurchaseOrderFragment
    }
    purchase_order_approval_rule {
      ...PurchaseOrderApprovalRuleFragment
    }
    purchase_order_approval_rule_metadata {
      ...PurchaseOrderApprovalRuleMetadataFragment
    }
    purchase_order_approval_rules {
      ...PurchaseOrderApprovalRulesFragment
    }
    purchase_orders {
      ...PurchaseOrdersFragment
    }
    purchase_orders_enabled
    requisition_lists {
      ...RequisitionListsFragment
    }
    return {
      ...ReturnFragment
    }
    returns {
      ...ReturnsFragment
    }
    reviews {
      ...ProductReviewsFragment
    }
    reward_points {
      ...RewardPointsFragment
    }
    role {
      ...CompanyRoleFragment
    }
    segments {
      ...CustomerSegmentFragment
    }
    status
    store_credit {
      ...CustomerStoreCreditFragment
    }
    structure_id
    suffix
    taxvat
    team {
      ...CompanyTeamFragment
    }
    telephone
    wishlist {
      ...WishlistFragment
    }
    wishlist_v2 {
      ...WishlistFragment
    }
    wishlists {
      ...WishlistFragment
    }
  }
}

Variables

{
  "currentPassword": "abc123",
  "newPassword": "abc123"
}

Response

{
  "data": {
    "changeCustomerPassword": {
      "addresses": [CustomerAddress],
      "addressesV2": CustomerAddresses,
      "allow_remote_shopping_assistance": false,
      "companies": UserCompaniesOutput,
      "compare_list": CompareList,
      "confirmation_status": "ACCOUNT_CONFIRMED",
      "created_at": "abc123",
      "custom_attributes": [AttributeValueInterface],
      "date_of_birth": "xyz789",
      "default_billing": "abc123",
      "default_shipping": "xyz789",
      "dob": "abc123",
      "email": "abc123",
      "firstname": "xyz789",
      "gender": 123,
      "gift_registries": [GiftRegistry],
      "gift_registry": GiftRegistry,
      "group": CustomerGroup,
      "group_id": 123,
      "id": 987,
      "is_subscribed": true,
      "job_title": "abc123",
      "lastname": "xyz789",
      "middlename": "abc123",
      "orders": CustomerOrders,
      "prefix": "abc123",
      "purchase_order": PurchaseOrder,
      "purchase_order_approval_rule": PurchaseOrderApprovalRule,
      "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata,
      "purchase_order_approval_rules": PurchaseOrderApprovalRules,
      "purchase_orders": PurchaseOrders,
      "purchase_orders_enabled": true,
      "requisition_lists": RequisitionLists,
      "return": Return,
      "returns": Returns,
      "reviews": ProductReviews,
      "reward_points": RewardPoints,
      "role": CompanyRole,
      "segments": [CustomerSegment],
      "status": "ACTIVE",
      "store_credit": CustomerStoreCredit,
      "structure_id": 4,
      "suffix": "xyz789",
      "taxvat": "abc123",
      "team": CompanyTeam,
      "telephone": "xyz789",
      "wishlist": Wishlist,
      "wishlist_v2": Wishlist,
      "wishlists": [Wishlist]
    }
  }
}

clearCart

Remove all items from the specified cart.

Response: ClearCartOutput!

Arguments

Example

Query

mutation clearCart($input: ClearCartInput!) {
  clearCart(input: $input) {
    cart {
      ...CartFragment
    }
    errors {
      ...ClearCartErrorFragment
    }
  }
}

Variables

{"input": ClearCartInput}

Response

{
  "data": {
    "clearCart": {
      "cart": Cart,
      "errors": [ClearCartError]
    }
  }
}

clearCustomerCart

Remove all items from the specified cart.

Response: ClearCustomerCartOutput

Arguments

Example

Query

mutation clearCustomerCart($cartUid: String!) {
  clearCustomerCart(cartUid: $cartUid) {
    cart {
      ...CartFragment
    }
    status
  }
}

Variables

{"cartUid": "xyz789"}

Response

{
  "data": {
    "clearCustomerCart": {"cart": Cart, "status": false}
  }
}

closeNegotiableQuotes

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

Response: CloseNegotiableQuotesOutput

Arguments

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

confirmCancelOrder

Cancel the specified guest customer order.

Response: CancelOrderOutput

Arguments

Example

Query

mutation confirmCancelOrder($input: ConfirmCancelOrderInput!) {
  confirmCancelOrder(input: $input) {
    error
    errorV2 {
      ...CancelOrderErrorFragment
    }
    order {
      ...CustomerOrderFragment
    }
  }
}

Variables

{"input": ConfirmCancelOrderInput}

Response

{
  "data": {
    "confirmCancelOrder": {
      "error": "xyz789",
      "errorV2": CancelOrderError,
      "order": CustomerOrder
    }
  }
}

confirmEmail

Confirms the email address for a customer.

Response: CustomerOutput

Arguments

Example

Query

mutation confirmEmail($input: ConfirmEmailInput!) {
  confirmEmail(input: $input) {
    customer {
      ...CustomerFragment
    }
  }
}

Variables

{"input": ConfirmEmailInput}

Response

{"data": {"confirmEmail": {"customer": Customer}}}

confirmReturn

Confirm the return.

Response: RequestReturnOutput

Arguments

Example

Query

mutation confirmReturn($input: ConfirmReturnInput!) {
  confirmReturn(input: $input) {
    return {
      ...ReturnFragment
    }
    returns {
      ...ReturnsFragment
    }
  }
}

Variables

{"input": ConfirmReturnInput}

Response

{
  "data": {
    "confirmReturn": {
      "return": Return,
      "returns": Returns
    }
  }
}

contactUs

Send a 'Contact Us' email to the merchant.

Response: ContactUsOutput

Arguments

Example

Query

mutation contactUs($input: ContactUsInput!) {
  contactUs(input: $input) {
    status
  }
}

Variables

{"input": ContactUsInput}

Response

{"data": {"contactUs": {"status": false}}}

copyItemsBetweenRequisitionLists

Copy items from one requisition list to another.

Response: CopyItemsFromRequisitionListsOutput

Arguments

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

copyProductsBetweenWishlists

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

Response: CopyProductsBetweenWishlistsOutput

Arguments

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

createBraintreeClientToken

Creates Client Token for Braintree Javascript SDK initialization.

Response: String!

Example

Query

mutation createBraintreeClientToken {
  createBraintreeClientToken
}

Response

{
  "data": {
    "createBraintreeClientToken": "abc123"
  }
}

createBraintreePayPalClientToken

Creates Client Token for Braintree PayPal Javascript SDK initialization.

Response: String!

Example

Query

mutation createBraintreePayPalClientToken {
  createBraintreePayPalClientToken
}

Response

{
  "data": {
    "createBraintreePayPalClientToken": "xyz789"
  }
}

createBraintreePayPalVaultClientToken

Creates Client Token for Braintree PayPal Vault Javascript SDK initialization.

Response: String!

Arguments

Example

Query

mutation createBraintreePayPalVaultClientToken($input: BraintreeVaultInput) {
  createBraintreePayPalVaultClientToken(input: $input)
}

Variables

{"input": BraintreeVaultInput}

Response

{
  "data": {
    "createBraintreePayPalVaultClientToken": "abc123"
  }
}

createCompany

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

Response: CreateCompanyOutput

Arguments

Example

Query

mutation createCompany($input: CompanyCreateInput!) {
  createCompany(input: $input) {
    company {
      ...CompanyFragment
    }
  }
}

Variables

{"input": CompanyCreateInput}

Response

{"data": {"createCompany": {"company": Company}}}

createCompanyRole

Create a new company role.

Response: CreateCompanyRoleOutput

Arguments

Example

Query

mutation createCompanyRole($input: CompanyRoleCreateInput!) {
  createCompanyRole(input: $input) {
    role {
      ...CompanyRoleFragment
    }
  }
}

Variables

{"input": CompanyRoleCreateInput}

Response

{"data": {"createCompanyRole": {"role": CompanyRole}}}

createCompanyTeam

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

Response: CreateCompanyTeamOutput

Arguments

Example

Query

mutation createCompanyTeam($input: CompanyTeamCreateInput!) {
  createCompanyTeam(input: $input) {
    team {
      ...CompanyTeamFragment
    }
  }
}

Variables

{"input": CompanyTeamCreateInput}

Response

{"data": {"createCompanyTeam": {"team": CompanyTeam}}}

createCompanyUser

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

Response: CreateCompanyUserOutput

Arguments

Example

Query

mutation createCompanyUser($input: CompanyUserCreateInput!) {
  createCompanyUser(input: $input) {
    user {
      ...CustomerFragment
    }
  }
}

Variables

{"input": CompanyUserCreateInput}

Response

{"data": {"createCompanyUser": {"user": Customer}}}

createCompareList

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

Response: CompareList

Arguments

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": 987,
      "items": [ComparableItem],
      "uid": "4"
    }
  }
}

createCustomer

Deprecated

Use createCustomerV2 instead.

Response: CustomerOutput

Arguments

Example

Query

mutation createCustomer($input: CustomerInput!) {
  createCustomer(input: $input) {
    customer {
      ...CustomerFragment
    }
  }
}

Variables

{"input": CustomerInput}

Response

{"data": {"createCustomer": {"customer": Customer}}}

createCustomerAddress

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

Response: CustomerAddress

Arguments

Example

Query

mutation createCustomerAddress($input: CustomerAddressInput!) {
  createCustomerAddress(input: $input) {
    city
    company
    country_code
    country_id
    custom_attributes {
      ...CustomerAddressAttributeFragment
    }
    custom_attributesV2 {
      ...AttributeValueInterfaceFragment
    }
    customer_id
    default_billing
    default_shipping
    extension_attributes {
      ...CustomerAddressAttributeFragment
    }
    fax
    firstname
    id
    lastname
    middlename
    postcode
    prefix
    region {
      ...CustomerAddressRegionFragment
    }
    region_id
    street
    suffix
    telephone
    vat_id
  }
}

Variables

{"input": CustomerAddressInput}

Response

{
  "data": {
    "createCustomerAddress": {
      "city": "abc123",
      "company": "xyz789",
      "country_code": "AF",
      "country_id": "abc123",
      "custom_attributes": [CustomerAddressAttribute],
      "custom_attributesV2": [AttributeValueInterface],
      "customer_id": 123,
      "default_billing": true,
      "default_shipping": false,
      "extension_attributes": [CustomerAddressAttribute],
      "fax": "abc123",
      "firstname": "abc123",
      "id": 987,
      "lastname": "xyz789",
      "middlename": "abc123",
      "postcode": "xyz789",
      "prefix": "abc123",
      "region": CustomerAddressRegion,
      "region_id": 123,
      "street": ["abc123"],
      "suffix": "xyz789",
      "telephone": "abc123",
      "vat_id": "xyz789"
    }
  }
}

createCustomerV2

Create a customer account.

Response: CustomerOutput

Arguments

Example

Query

mutation createCustomerV2($input: CustomerCreateInput!) {
  createCustomerV2(input: $input) {
    customer {
      ...CustomerFragment
    }
  }
}

Variables

{"input": CustomerCreateInput}

Response

{"data": {"createCustomerV2": {"customer": Customer}}}

createEmptyCart

Deprecated

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

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

Response: String

Arguments

Example

Query

mutation createEmptyCart($input: createEmptyCartInput) {
  createEmptyCart(input: $input)
}

Variables

{"input": createEmptyCartInput}

Response

{"data": {"createEmptyCart": "xyz789"}}

createGiftRegistry

Create a gift registry on behalf of the customer.

Response: CreateGiftRegistryOutput

Arguments

Example

Query

mutation createGiftRegistry($giftRegistry: CreateGiftRegistryInput!) {
  createGiftRegistry(giftRegistry: $giftRegistry) {
    gift_registry {
      ...GiftRegistryFragment
    }
  }
}

Variables

{"giftRegistry": CreateGiftRegistryInput}

Response

{
  "data": {
    "createGiftRegistry": {"gift_registry": GiftRegistry}
  }
}

createGuestCart

Create a new shopping cart

Response: CreateGuestCartOutput

Arguments

Example

Query

mutation createGuestCart($input: CreateGuestCartInput) {
  createGuestCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}

Variables

{"input": CreateGuestCartInput}

Response

{"data": {"createGuestCart": {"cart": Cart}}}

createPayflowProToken

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

Response: CreatePayflowProTokenOutput

Arguments

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

createPaymentOrder

Creates a payment order for further payment processing

Response: CreatePaymentOrderOutput

Arguments

Example

Query

mutation createPaymentOrder($input: CreatePaymentOrderInput!) {
  createPaymentOrder(input: $input) {
    amount
    currency_code
    id
    mp_order_id
    status
  }
}

Variables

{"input": CreatePaymentOrderInput}

Response

{
  "data": {
    "createPaymentOrder": {
      "amount": 123.45,
      "currency_code": "xyz789",
      "id": "abc123",
      "mp_order_id": "xyz789",
      "status": "xyz789"
    }
  }
}

createPaypalExpressToken

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

Response: PaypalExpressTokenOutput

Arguments

Example

Query

mutation createPaypalExpressToken($input: PaypalExpressTokenInput!) {
  createPaypalExpressToken(input: $input) {
    paypal_urls {
      ...PaypalExpressUrlListFragment
    }
    token
  }
}

Variables

{"input": PaypalExpressTokenInput}

Response

{
  "data": {
    "createPaypalExpressToken": {
      "paypal_urls": PaypalExpressUrlList,
      "token": "xyz789"
    }
  }
}

createProductReview

Create a product review for the specified product.

Response: CreateProductReviewOutput!

Arguments

Example

Query

mutation createProductReview($input: CreateProductReviewInput!) {
  createProductReview(input: $input) {
    review {
      ...ProductReviewFragment
    }
  }
}

Variables

{"input": CreateProductReviewInput}

Response

{
  "data": {
    "createProductReview": {"review": ProductReview}
  }
}

createPurchaseOrderApprovalRule

Create a purchase order approval rule.

Response: PurchaseOrderApprovalRule

Arguments

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

createRequisitionList

Create an empty requisition list.

Response: CreateRequisitionListOutput

Arguments

Example

Query

mutation createRequisitionList($input: CreateRequisitionListInput) {
  createRequisitionList(input: $input) {
    requisition_list {
      ...RequisitionListFragment
    }
  }
}

Variables

{"input": CreateRequisitionListInput}

Response

{
  "data": {
    "createRequisitionList": {
      "requisition_list": RequisitionList
    }
  }
}

createVaultCardPaymentToken

Creates a vault payment token

Response: CreateVaultCardPaymentTokenOutput

Arguments

Example

Query

mutation createVaultCardPaymentToken($input: CreateVaultCardPaymentTokenInput!) {
  createVaultCardPaymentToken(input: $input) {
    payment_source {
      ...PaymentSourceOutputFragment
    }
    vault_token_id
  }
}

Variables

{"input": CreateVaultCardPaymentTokenInput}

Response

{
  "data": {
    "createVaultCardPaymentToken": {
      "payment_source": PaymentSourceOutput,
      "vault_token_id": "xyz789"
    }
  }
}

createVaultCardSetupToken

Creates a vault card setup token

Response: CreateVaultCardSetupTokenOutput

Arguments

Example

Query

mutation createVaultCardSetupToken($input: CreateVaultCardSetupTokenInput!) {
  createVaultCardSetupToken(input: $input) {
    setup_token
  }
}

Variables

{"input": CreateVaultCardSetupTokenInput}

Response

{
  "data": {
    "createVaultCardSetupToken": {
      "setup_token": "abc123"
    }
  }
}

createWishlist

Create a new wish list.

Response: CreateWishlistOutput

Arguments

Example

Query

mutation createWishlist($input: CreateWishlistInput!) {
  createWishlist(input: $input) {
    wishlist {
      ...WishlistFragment
    }
  }
}

Variables

{"input": CreateWishlistInput}

Response

{"data": {"createWishlist": {"wishlist": Wishlist}}}

deleteCompanyRole

Delete the specified company role.

Response: DeleteCompanyRoleOutput

Arguments

Example

Query

mutation deleteCompanyRole($id: ID!) {
  deleteCompanyRole(id: $id) {
    success
  }
}

Variables

{"id": "4"}

Response

{"data": {"deleteCompanyRole": {"success": false}}}

deleteCompanyTeam

Delete the specified company team.

Response: DeleteCompanyTeamOutput

Arguments

Example

Query

mutation deleteCompanyTeam($id: ID!) {
  deleteCompanyTeam(id: $id) {
    success
  }
}

Variables

{"id": 4}

Response

{"data": {"deleteCompanyTeam": {"success": true}}}

deleteCompanyUser

Deprecated

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

Delete the specified company user.

Response: DeleteCompanyUserOutput

Arguments

Example

Query

mutation deleteCompanyUser($id: ID!) {
  deleteCompanyUser(id: $id) {
    success
  }
}

Variables

{"id": 4}

Response

{"data": {"deleteCompanyUser": {"success": true}}}

deleteCompanyUserV2

Delete the specified company user.

Response: DeleteCompanyUserOutput

Arguments

Example

Query

mutation deleteCompanyUserV2($id: ID!) {
  deleteCompanyUserV2(id: $id) {
    success
  }
}

Variables

{"id": "4"}

Response

{"data": {"deleteCompanyUserV2": {"success": false}}}

deleteCompareList

Delete the specified compare list.

Response: DeleteCompareListOutput

Arguments

Example

Query

mutation deleteCompareList($uid: ID!) {
  deleteCompareList(uid: $uid) {
    result
  }
}

Variables

{"uid": "4"}

Response

{"data": {"deleteCompareList": {"result": true}}}

deleteCustomer

Delete customer account

Response: Boolean

Example

Query

mutation deleteCustomer {
  deleteCustomer
}

Response

{"data": {"deleteCustomer": false}}

deleteCustomerAddress

Delete the billing or shipping address of a customer.

Response: Boolean

Arguments

Example

Query

mutation deleteCustomerAddress($id: Int!) {
  deleteCustomerAddress(id: $id)
}

Variables

{"id": 987}

Response

{"data": {"deleteCustomerAddress": false}}

deleteNegotiableQuoteTemplate

Delete a negotiable quote template

Response: Boolean!

Arguments

Example

Query

mutation deleteNegotiableQuoteTemplate($input: DeleteNegotiableQuoteTemplateInput!) {
  deleteNegotiableQuoteTemplate(input: $input)
}

Variables

{"input": DeleteNegotiableQuoteTemplateInput}

Response

{"data": {"deleteNegotiableQuoteTemplate": false}}

deleteNegotiableQuotes

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

Response: DeleteNegotiableQuotesOutput

Arguments

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

deletePaymentToken

Delete a customer's payment token.

Response: DeletePaymentTokenOutput

Arguments

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

deletePurchaseOrderApprovalRule

Delete existing purchase order approval rules.

Response: DeletePurchaseOrderApprovalRuleOutput

Arguments

Example

Query

mutation deletePurchaseOrderApprovalRule($input: DeletePurchaseOrderApprovalRuleInput!) {
  deletePurchaseOrderApprovalRule(input: $input) {
    errors {
      ...DeletePurchaseOrderApprovalRuleErrorFragment
    }
  }
}

Variables

{"input": DeletePurchaseOrderApprovalRuleInput}

Response

{
  "data": {
    "deletePurchaseOrderApprovalRule": {
      "errors": [DeletePurchaseOrderApprovalRuleError]
    }
  }
}

deleteRequisitionList

Delete a requisition list.

Response: DeleteRequisitionListOutput

Arguments

Example

Query

mutation deleteRequisitionList($requisitionListUid: ID!) {
  deleteRequisitionList(requisitionListUid: $requisitionListUid) {
    requisition_lists {
      ...RequisitionListsFragment
    }
    status
  }
}

Variables

{"requisitionListUid": "4"}

Response

{
  "data": {
    "deleteRequisitionList": {
      "requisition_lists": RequisitionLists,
      "status": false
    }
  }
}

deleteRequisitionListItems

Delete items from a requisition list.

Response: DeleteRequisitionListItemsOutput

Arguments

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

deleteWishlist

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

Response: DeleteWishlistOutput

Arguments

Example

Query

mutation deleteWishlist($wishlistId: ID!) {
  deleteWishlist(wishlistId: $wishlistId) {
    status
    wishlists {
      ...WishlistFragment
    }
  }
}

Variables

{"wishlistId": 4}

Response

{
  "data": {
    "deleteWishlist": {
      "status": true,
      "wishlists": [Wishlist]
    }
  }
}

duplicateNegotiableQuote

Negotiable Quote resulting from duplication operation.

Response: DuplicateNegotiableQuoteOutput

Arguments

Example

Query

mutation duplicateNegotiableQuote($input: DuplicateNegotiableQuoteInput!) {
  duplicateNegotiableQuote(input: $input) {
    quote {
      ...NegotiableQuoteFragment
    }
  }
}

Variables

{"input": DuplicateNegotiableQuoteInput}

Response

{
  "data": {
    "duplicateNegotiableQuote": {"quote": NegotiableQuote}
  }
}

estimateShippingMethods

Estimate shipping method(s) for cart based on address

Response: [AvailableShippingMethod]

Arguments

Example

Query

mutation estimateShippingMethods($input: EstimateTotalsInput!) {
  estimateShippingMethods(input: $input) {
    amount {
      ...MoneyFragment
    }
    available
    base_amount {
      ...MoneyFragment
    }
    carrier_code
    carrier_title
    error_message
    method_code
    method_title
    price_excl_tax {
      ...MoneyFragment
    }
    price_incl_tax {
      ...MoneyFragment
    }
  }
}

Variables

{"input": EstimateTotalsInput}

Response

{
  "data": {
    "estimateShippingMethods": [
      {
        "amount": Money,
        "available": false,
        "base_amount": Money,
        "carrier_code": "abc123",
        "carrier_title": "abc123",
        "error_message": "xyz789",
        "method_code": "abc123",
        "method_title": "abc123",
        "price_excl_tax": Money,
        "price_incl_tax": Money
      }
    ]
  }
}

estimateTotals

Estimate totals for cart based on the address

Response: EstimateTotalsOutput!

Arguments

Example

Query

mutation estimateTotals($input: EstimateTotalsInput!) {
  estimateTotals(input: $input) {
    cart {
      ...CartFragment
    }
  }
}

Variables

{"input": EstimateTotalsInput}

Response

{"data": {"estimateTotals": {"cart": Cart}}}

generateCustomerToken

Generate a token for specified customer.

Response: CustomerToken

Arguments

Example

Query

mutation generateCustomerToken(
  $email: String!,
  $password: String!
) {
  generateCustomerToken(
    email: $email,
    password: $password
  ) {
    token
  }
}

Variables

{
  "email": "xyz789",
  "password": "abc123"
}

Response

{
  "data": {
    "generateCustomerToken": {
      "token": "xyz789"
    }
  }
}

generateCustomerTokenAsAdmin

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

Response: GenerateCustomerTokenAsAdminOutput

Arguments

Example

Query

mutation generateCustomerTokenAsAdmin($input: GenerateCustomerTokenAsAdminInput!) {
  generateCustomerTokenAsAdmin(input: $input) {
    customer_token
  }
}

Variables

{"input": GenerateCustomerTokenAsAdminInput}

Response

{
  "data": {
    "generateCustomerTokenAsAdmin": {
      "customer_token": "abc123"
    }
  }
}

generateNegotiableQuoteFromTemplate

Generate a negotiable quote from an accept quote template.

Response: GenerateNegotiableQuoteFromTemplateOutput

Arguments

Example

Query

mutation generateNegotiableQuoteFromTemplate($input: GenerateNegotiableQuoteFromTemplateInput!) {
  generateNegotiableQuoteFromTemplate(input: $input) {
    negotiable_quote_uid
  }
}

Variables

{"input": GenerateNegotiableQuoteFromTemplateInput}

Response

{
  "data": {
    "generateNegotiableQuoteFromTemplate": {
      "negotiable_quote_uid": "4"
    }
  }
}

handlePayflowProResponse

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

Response: PayflowProResponseOutput

Arguments

Example

Query

mutation handlePayflowProResponse($input: PayflowProResponseInput!) {
  handlePayflowProResponse(input: $input) {
    cart {
      ...CartFragment
    }
  }
}

Variables

{"input": PayflowProResponseInput}

Response

{"data": {"handlePayflowProResponse": {"cart": Cart}}}

mergeCarts

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

Response: Cart!

Arguments

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
    }
    itemsV2 {
      ...CartItemsFragment
    }
    prices {
      ...CartPricesFragment
    }
    printed_card_included
    rules {
      ...CartRuleFragment
    }
    selected_payment_method {
      ...SelectedPaymentMethodFragment
    }
    shipping_addresses {
      ...ShippingCartAddressFragment
    }
    total_quantity
  }
}

Variables

{
  "source_cart_id": "xyz789",
  "destination_cart_id": "abc123"
}

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],
      "itemsV2": CartItems,
      "prices": CartPrices,
      "printed_card_included": true,
      "rules": [CartRule],
      "selected_payment_method": SelectedPaymentMethod,
      "shipping_addresses": [ShippingCartAddress],
      "total_quantity": 123.45
    }
  }
}

moveCartItemsToGiftRegistry

Move all items from the cart to a gift registry.

Response: MoveCartItemsToGiftRegistryOutput

Arguments

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": false,
      "user_errors": [GiftRegistryItemsUserError]
    }
  }
}

moveItemsBetweenRequisitionLists

Move Items from one requisition list to another.

Response: MoveItemsBetweenRequisitionListsOutput

Arguments

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

moveLineItemToRequisitionList

Move negotiable quote item to requisition list.

Response: MoveLineItemToRequisitionListOutput

Arguments

Example

Query

mutation moveLineItemToRequisitionList($input: MoveLineItemToRequisitionListInput!) {
  moveLineItemToRequisitionList(input: $input) {
    quote {
      ...NegotiableQuoteFragment
    }
  }
}

Variables

{"input": MoveLineItemToRequisitionListInput}

Response

{
  "data": {
    "moveLineItemToRequisitionList": {
      "quote": NegotiableQuote
    }
  }
}

moveProductsBetweenWishlists

Move products from one wish list to another.

Response: MoveProductsBetweenWishlistsOutput

Arguments

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

openNegotiableQuoteTemplate

Open an existing negotiable quote template.

Response: NegotiableQuoteTemplate

Arguments

Example

Query

mutation openNegotiableQuoteTemplate($input: OpenNegotiableQuoteTemplateInput!) {
  openNegotiableQuoteTemplate(input: $input) {
    buyer {
      ...NegotiableQuoteUserFragment
    }
    comments {
      ...NegotiableQuoteCommentFragment
    }
    expiration_date
    history {
      ...NegotiableQuoteHistoryEntryFragment
    }
    is_min_max_qty_used
    is_virtual
    items {
      ...CartItemInterfaceFragment
    }
    max_order_commitment
    min_order_commitment
    name
    notifications {
      ...QuoteTemplateNotificationMessageFragment
    }
    prices {
      ...CartPricesFragment
    }
    reference_document_links {
      ...NegotiableQuoteReferenceDocumentLinkFragment
    }
    shipping_addresses {
      ...NegotiableQuoteShippingAddressFragment
    }
    status
    template_id
    total_quantity
  }
}

Variables

{"input": OpenNegotiableQuoteTemplateInput}

Response

{
  "data": {
    "openNegotiableQuoteTemplate": {
      "buyer": NegotiableQuoteUser,
      "comments": [NegotiableQuoteComment],
      "expiration_date": "abc123",
      "history": [NegotiableQuoteHistoryEntry],
      "is_min_max_qty_used": false,
      "is_virtual": true,
      "items": [CartItemInterface],
      "max_order_commitment": 987,
      "min_order_commitment": 987,
      "name": "abc123",
      "notifications": [QuoteTemplateNotificationMessage],
      "prices": CartPrices,
      "reference_document_links": [
        NegotiableQuoteReferenceDocumentLink
      ],
      "shipping_addresses": [
        NegotiableQuoteShippingAddress
      ],
      "status": "xyz789",
      "template_id": "4",
      "total_quantity": 987.65
    }
  }
}

placeNegotiableQuoteOrder

Convert a negotiable quote into an order.

Response: PlaceNegotiableQuoteOrderOutput

Arguments

Example

Query

mutation placeNegotiableQuoteOrder($input: PlaceNegotiableQuoteOrderInput!) {
  placeNegotiableQuoteOrder(input: $input) {
    order {
      ...OrderFragment
    }
  }
}

Variables

{"input": PlaceNegotiableQuoteOrderInput}

Response

{"data": {"placeNegotiableQuoteOrder": {"order": Order}}}

placeOrder

Convert the quote into an order.

Response: PlaceOrderOutput

Arguments

Example

Query

mutation placeOrder($input: PlaceOrderInput) {
  placeOrder(input: $input) {
    errors {
      ...PlaceOrderErrorFragment
    }
    order {
      ...OrderFragment
    }
    orderV2 {
      ...CustomerOrderFragment
    }
  }
}

Variables

{"input": PlaceOrderInput}

Response

{
  "data": {
    "placeOrder": {
      "errors": [PlaceOrderError],
      "order": Order,
      "orderV2": CustomerOrder
    }
  }
}

placeOrderForPurchaseOrder

Convert the purchase order into an order.

Response: PlaceOrderForPurchaseOrderOutput

Arguments

Example

Query

mutation placeOrderForPurchaseOrder($input: PlaceOrderForPurchaseOrderInput!) {
  placeOrderForPurchaseOrder(input: $input) {
    order {
      ...CustomerOrderFragment
    }
  }
}

Variables

{"input": PlaceOrderForPurchaseOrderInput}

Response

{
  "data": {
    "placeOrderForPurchaseOrder": {"order": CustomerOrder}
  }
}

placePurchaseOrder

Place a purchase order.

Response: PlacePurchaseOrderOutput

Arguments

Example

Query

mutation placePurchaseOrder($input: PlacePurchaseOrderInput!) {
  placePurchaseOrder(input: $input) {
    purchase_order {
      ...PurchaseOrderFragment
    }
  }
}

Variables

{"input": PlacePurchaseOrderInput}

Response

{
  "data": {
    "placePurchaseOrder": {
      "purchase_order": PurchaseOrder
    }
  }
}

redeemGiftCardBalanceAsStoreCredit

Redeem a gift card for store credit.

Response: GiftCardAccount

Arguments

Example

Query

mutation redeemGiftCardBalanceAsStoreCredit($input: GiftCardAccountInput!) {
  redeemGiftCardBalanceAsStoreCredit(input: $input) {
    balance {
      ...MoneyFragment
    }
    code
    expiration_date
  }
}

Variables

{"input": GiftCardAccountInput}

Response

{
  "data": {
    "redeemGiftCardBalanceAsStoreCredit": {
      "balance": Money,
      "code": "xyz789",
      "expiration_date": "xyz789"
    }
  }
}

rejectPurchaseOrders

Reject purchase orders.

Response: PurchaseOrdersActionOutput

Arguments

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

removeCouponFromCart

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

Response: RemoveCouponFromCartOutput

Arguments

Example

Query

mutation removeCouponFromCart($input: RemoveCouponFromCartInput) {
  removeCouponFromCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}

Variables

{"input": RemoveCouponFromCartInput}

Response

{"data": {"removeCouponFromCart": {"cart": Cart}}}

removeCouponsFromCart

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

Response: RemoveCouponFromCartOutput

Arguments

Example

Query

mutation removeCouponsFromCart($input: RemoveCouponsFromCartInput) {
  removeCouponsFromCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}

Variables

{"input": RemoveCouponsFromCartInput}

Response

{"data": {"removeCouponsFromCart": {"cart": Cart}}}

removeGiftCardFromCart

Removes a gift card from the cart.

Response: RemoveGiftCardFromCartOutput

Arguments

Example

Query

mutation removeGiftCardFromCart($input: RemoveGiftCardFromCartInput) {
  removeGiftCardFromCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}

Variables

{"input": RemoveGiftCardFromCartInput}

Response

{"data": {"removeGiftCardFromCart": {"cart": Cart}}}

removeGiftRegistry

Delete the specified gift registry.

Response: RemoveGiftRegistryOutput

Arguments

Example

Query

mutation removeGiftRegistry($giftRegistryUid: ID!) {
  removeGiftRegistry(giftRegistryUid: $giftRegistryUid) {
    success
  }
}

Variables

{"giftRegistryUid": 4}

Response

{"data": {"removeGiftRegistry": {"success": true}}}

removeGiftRegistryItems

Delete the specified items from a gift registry.

Response: RemoveGiftRegistryItemsOutput

Arguments

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

removeGiftRegistryRegistrants

Removes registrants from a gift registry.

Response: RemoveGiftRegistryRegistrantsOutput

Arguments

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

removeItemFromCart

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

Response: RemoveItemFromCartOutput

Arguments

Example

Query

mutation removeItemFromCart($input: RemoveItemFromCartInput) {
  removeItemFromCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}

Variables

{"input": RemoveItemFromCartInput}

Response

{"data": {"removeItemFromCart": {"cart": Cart}}}

removeNegotiableQuoteItems

Remove one or more products from a negotiable quote.

Response: RemoveNegotiableQuoteItemsOutput

Arguments

Example

Query

mutation removeNegotiableQuoteItems($input: RemoveNegotiableQuoteItemsInput!) {
  removeNegotiableQuoteItems(input: $input) {
    quote {
      ...NegotiableQuoteFragment
    }
  }
}

Variables

{"input": RemoveNegotiableQuoteItemsInput}

Response

{
  "data": {
    "removeNegotiableQuoteItems": {
      "quote": NegotiableQuote
    }
  }
}

removeNegotiableQuoteTemplateItems

Remove one or more products from a negotiable quote template.

Response: NegotiableQuoteTemplate

Arguments

Example

Query

mutation removeNegotiableQuoteTemplateItems($input: RemoveNegotiableQuoteTemplateItemsInput!) {
  removeNegotiableQuoteTemplateItems(input: $input) {
    buyer {
      ...NegotiableQuoteUserFragment
    }
    comments {
      ...NegotiableQuoteCommentFragment
    }
    expiration_date
    history {
      ...NegotiableQuoteHistoryEntryFragment
    }
    is_min_max_qty_used
    is_virtual
    items {
      ...CartItemInterfaceFragment
    }
    max_order_commitment
    min_order_commitment
    name
    notifications {
      ...QuoteTemplateNotificationMessageFragment
    }
    prices {
      ...CartPricesFragment
    }
    reference_document_links {
      ...NegotiableQuoteReferenceDocumentLinkFragment
    }
    shipping_addresses {
      ...NegotiableQuoteShippingAddressFragment
    }
    status
    template_id
    total_quantity
  }
}

Variables

{"input": RemoveNegotiableQuoteTemplateItemsInput}

Response

{
  "data": {
    "removeNegotiableQuoteTemplateItems": {
      "buyer": NegotiableQuoteUser,
      "comments": [NegotiableQuoteComment],
      "expiration_date": "abc123",
      "history": [NegotiableQuoteHistoryEntry],
      "is_min_max_qty_used": true,
      "is_virtual": false,
      "items": [CartItemInterface],
      "max_order_commitment": 123,
      "min_order_commitment": 123,
      "name": "xyz789",
      "notifications": [QuoteTemplateNotificationMessage],
      "prices": CartPrices,
      "reference_document_links": [
        NegotiableQuoteReferenceDocumentLink
      ],
      "shipping_addresses": [
        NegotiableQuoteShippingAddress
      ],
      "status": "xyz789",
      "template_id": "4",
      "total_quantity": 987.65
    }
  }
}

removeProductsFromCompareList

Remove products from the specified compare list.

Response: CompareList

Arguments

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

removeProductsFromWishlist

Remove one or more products from the specified wish list.

Response: RemoveProductsFromWishlistOutput

Arguments

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

removeReturnTracking

Remove a tracked shipment from a return.

Response: RemoveReturnTrackingOutput

Arguments

Example

Query

mutation removeReturnTracking($input: RemoveReturnTrackingInput!) {
  removeReturnTracking(input: $input) {
    return {
      ...ReturnFragment
    }
  }
}

Variables

{"input": RemoveReturnTrackingInput}

Response

{"data": {"removeReturnTracking": {"return": Return}}}

removeRewardPointsFromCart

Cancel the application of reward points to the cart.

Response: RemoveRewardPointsFromCartOutput

Arguments

Example

Query

mutation removeRewardPointsFromCart($cartId: ID!) {
  removeRewardPointsFromCart(cartId: $cartId) {
    cart {
      ...CartFragment
    }
  }
}

Variables

{"cartId": "4"}

Response

{"data": {"removeRewardPointsFromCart": {"cart": Cart}}}

removeStoreCreditFromCart

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

Response: RemoveStoreCreditFromCartOutput

Arguments

Example

Query

mutation removeStoreCreditFromCart($input: RemoveStoreCreditFromCartInput!) {
  removeStoreCreditFromCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}

Variables

{"input": RemoveStoreCreditFromCartInput}

Response

{"data": {"removeStoreCreditFromCart": {"cart": Cart}}}

renameNegotiableQuote

Rename negotiable quote.

Response: RenameNegotiableQuoteOutput

Arguments

Example

Query

mutation renameNegotiableQuote($input: RenameNegotiableQuoteInput!) {
  renameNegotiableQuote(input: $input) {
    quote {
      ...NegotiableQuoteFragment
    }
  }
}

Variables

{"input": RenameNegotiableQuoteInput}

Response

{
  "data": {
    "renameNegotiableQuote": {"quote": NegotiableQuote}
  }
}

reorderItems

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

Response: ReorderItemsOutput

Arguments

Example

Query

mutation reorderItems($orderNumber: String!) {
  reorderItems(orderNumber: $orderNumber) {
    cart {
      ...CartFragment
    }
    userInputErrors {
      ...CheckoutUserInputErrorFragment
    }
  }
}

Variables

{"orderNumber": "xyz789"}

Response

{
  "data": {
    "reorderItems": {
      "cart": Cart,
      "userInputErrors": [CheckoutUserInputError]
    }
  }
}

requestGuestOrderCancel

Request to cancel specified guest order.

Response: CancelOrderOutput

Arguments

Example

Query

mutation requestGuestOrderCancel($input: GuestOrderCancelInput!) {
  requestGuestOrderCancel(input: $input) {
    error
    errorV2 {
      ...CancelOrderErrorFragment
    }
    order {
      ...CustomerOrderFragment
    }
  }
}

Variables

{"input": GuestOrderCancelInput}

Response

{
  "data": {
    "requestGuestOrderCancel": {
      "error": "xyz789",
      "errorV2": CancelOrderError,
      "order": CustomerOrder
    }
  }
}

requestGuestReturn

Response: RequestReturnOutput

Arguments

Example

Query

mutation requestGuestReturn($input: RequestGuestReturnInput!) {
  requestGuestReturn(input: $input) {
    return {
      ...ReturnFragment
    }
    returns {
      ...ReturnsFragment
    }
  }
}

Variables

{"input": RequestGuestReturnInput}

Response

{
  "data": {
    "requestGuestReturn": {
      "return": Return,
      "returns": Returns
    }
  }
}

requestNegotiableQuote

Request a new negotiable quote on behalf of the buyer.

Response: RequestNegotiableQuoteOutput

Arguments

Example

Query

mutation requestNegotiableQuote($input: RequestNegotiableQuoteInput!) {
  requestNegotiableQuote(input: $input) {
    quote {
      ...NegotiableQuoteFragment
    }
  }
}

Variables

{"input": RequestNegotiableQuoteInput}

Response

{
  "data": {
    "requestNegotiableQuote": {"quote": NegotiableQuote}
  }
}

requestNegotiableQuoteTemplateFromQuote

Request a new negotiable quote on behalf of the buyer.

Response: NegotiableQuoteTemplate

Arguments

Example

Query

mutation requestNegotiableQuoteTemplateFromQuote($input: RequestNegotiableQuoteTemplateInput!) {
  requestNegotiableQuoteTemplateFromQuote(input: $input) {
    buyer {
      ...NegotiableQuoteUserFragment
    }
    comments {
      ...NegotiableQuoteCommentFragment
    }
    expiration_date
    history {
      ...NegotiableQuoteHistoryEntryFragment
    }
    is_min_max_qty_used
    is_virtual
    items {
      ...CartItemInterfaceFragment
    }
    max_order_commitment
    min_order_commitment
    name
    notifications {
      ...QuoteTemplateNotificationMessageFragment
    }
    prices {
      ...CartPricesFragment
    }
    reference_document_links {
      ...NegotiableQuoteReferenceDocumentLinkFragment
    }
    shipping_addresses {
      ...NegotiableQuoteShippingAddressFragment
    }
    status
    template_id
    total_quantity
  }
}

Variables

{"input": RequestNegotiableQuoteTemplateInput}

Response

{
  "data": {
    "requestNegotiableQuoteTemplateFromQuote": {
      "buyer": NegotiableQuoteUser,
      "comments": [NegotiableQuoteComment],
      "expiration_date": "abc123",
      "history": [NegotiableQuoteHistoryEntry],
      "is_min_max_qty_used": false,
      "is_virtual": false,
      "items": [CartItemInterface],
      "max_order_commitment": 987,
      "min_order_commitment": 987,
      "name": "xyz789",
      "notifications": [QuoteTemplateNotificationMessage],
      "prices": CartPrices,
      "reference_document_links": [
        NegotiableQuoteReferenceDocumentLink
      ],
      "shipping_addresses": [
        NegotiableQuoteShippingAddress
      ],
      "status": "xyz789",
      "template_id": 4,
      "total_quantity": 987.65
    }
  }
}

requestPasswordResetEmail

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

Response: Boolean

Arguments

Example

Query

mutation requestPasswordResetEmail($email: String!) {
  requestPasswordResetEmail(email: $email)
}

Variables

{"email": "xyz789"}

Response

{"data": {"requestPasswordResetEmail": true}}

requestReturn

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

Response: RequestReturnOutput

Arguments

Example

Query

mutation requestReturn($input: RequestReturnInput!) {
  requestReturn(input: $input) {
    return {
      ...ReturnFragment
    }
    returns {
      ...ReturnsFragment
    }
  }
}

Variables

{"input": RequestReturnInput}

Response

{
  "data": {
    "requestReturn": {
      "return": Return,
      "returns": Returns
    }
  }
}

resendConfirmationEmail

Resends the confirmation email to a customer.

Response: Boolean

Arguments

Example

Query

mutation resendConfirmationEmail($email: String!) {
  resendConfirmationEmail(email: $email)
}

Variables

{"email": "abc123"}

Response

{"data": {"resendConfirmationEmail": true}}

resetPassword

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

Response: Boolean

Arguments

Example

Query

mutation resetPassword(
  $email: String!,
  $resetPasswordToken: String!,
  $newPassword: String!
) {
  resetPassword(
    email: $email,
    resetPasswordToken: $resetPasswordToken,
    newPassword: $newPassword
  )
}

Variables

{
  "email": "abc123",
  "resetPasswordToken": "xyz789",
  "newPassword": "xyz789"
}

Response

{"data": {"resetPassword": false}}

revokeCustomerToken

Revoke the customer token.

Response: RevokeCustomerTokenOutput

Example

Query

mutation revokeCustomerToken {
  revokeCustomerToken {
    result
  }
}

Response

{"data": {"revokeCustomerToken": {"result": true}}}

sendEmailToFriend

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

Response: SendEmailToFriendOutput

Arguments

Example

Query

mutation sendEmailToFriend($input: SendEmailToFriendInput) {
  sendEmailToFriend(input: $input) {
    recipients {
      ...SendEmailToFriendRecipientFragment
    }
    sender {
      ...SendEmailToFriendSenderFragment
    }
  }
}

Variables

{"input": SendEmailToFriendInput}

Response

{
  "data": {
    "sendEmailToFriend": {
      "recipients": [SendEmailToFriendRecipient],
      "sender": SendEmailToFriendSender
    }
  }
}

sendNegotiableQuoteForReview

Send the negotiable quote to the seller for review.

Response: SendNegotiableQuoteForReviewOutput

Arguments

Example

Query

mutation sendNegotiableQuoteForReview($input: SendNegotiableQuoteForReviewInput!) {
  sendNegotiableQuoteForReview(input: $input) {
    quote {
      ...NegotiableQuoteFragment
    }
  }
}

Variables

{"input": SendNegotiableQuoteForReviewInput}

Response

{
  "data": {
    "sendNegotiableQuoteForReview": {
      "quote": NegotiableQuote
    }
  }
}

setBillingAddressOnCart

Set the billing address on a specific cart.

Response: SetBillingAddressOnCartOutput

Arguments

Example

Query

mutation setBillingAddressOnCart($input: SetBillingAddressOnCartInput) {
  setBillingAddressOnCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}

Variables

{"input": SetBillingAddressOnCartInput}

Response

{"data": {"setBillingAddressOnCart": {"cart": Cart}}}

setGiftOptionsOnCart

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

Response: SetGiftOptionsOnCartOutput

Arguments

Example

Query

mutation setGiftOptionsOnCart($input: SetGiftOptionsOnCartInput) {
  setGiftOptionsOnCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}

Variables

{"input": SetGiftOptionsOnCartInput}

Response

{"data": {"setGiftOptionsOnCart": {"cart": Cart}}}

setGuestEmailOnCart

Assign the email address of a guest to the cart.

Response: SetGuestEmailOnCartOutput

Arguments

Example

Query

mutation setGuestEmailOnCart($input: SetGuestEmailOnCartInput) {
  setGuestEmailOnCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}

Variables

{"input": SetGuestEmailOnCartInput}

Response

{"data": {"setGuestEmailOnCart": {"cart": Cart}}}

setLineItemNote

Add buyer's note to a negotiable quote item.

Response: SetLineItemNoteOutput

Arguments

Example

Query

mutation setLineItemNote($input: LineItemNoteInput!) {
  setLineItemNote(input: $input) {
    quote {
      ...NegotiableQuoteFragment
    }
  }
}

Variables

{"input": LineItemNoteInput}

Response

{"data": {"setLineItemNote": {"quote": NegotiableQuote}}}

setNegotiableQuoteBillingAddress

Assign a billing address to a negotiable quote.

Response: SetNegotiableQuoteBillingAddressOutput

Arguments

Example

Query

mutation setNegotiableQuoteBillingAddress($input: SetNegotiableQuoteBillingAddressInput!) {
  setNegotiableQuoteBillingAddress(input: $input) {
    quote {
      ...NegotiableQuoteFragment
    }
  }
}

Variables

{"input": SetNegotiableQuoteBillingAddressInput}

Response

{
  "data": {
    "setNegotiableQuoteBillingAddress": {
      "quote": NegotiableQuote
    }
  }
}

setNegotiableQuotePaymentMethod

Set the payment method on a negotiable quote.

Response: SetNegotiableQuotePaymentMethodOutput

Arguments

Example

Query

mutation setNegotiableQuotePaymentMethod($input: SetNegotiableQuotePaymentMethodInput!) {
  setNegotiableQuotePaymentMethod(input: $input) {
    quote {
      ...NegotiableQuoteFragment
    }
  }
}

Variables

{"input": SetNegotiableQuotePaymentMethodInput}

Response

{
  "data": {
    "setNegotiableQuotePaymentMethod": {
      "quote": NegotiableQuote
    }
  }
}

setNegotiableQuoteShippingAddress

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

Response: SetNegotiableQuoteShippingAddressOutput

Arguments

Example

Query

mutation setNegotiableQuoteShippingAddress($input: SetNegotiableQuoteShippingAddressInput!) {
  setNegotiableQuoteShippingAddress(input: $input) {
    quote {
      ...NegotiableQuoteFragment
    }
  }
}

Variables

{"input": SetNegotiableQuoteShippingAddressInput}

Response

{
  "data": {
    "setNegotiableQuoteShippingAddress": {
      "quote": NegotiableQuote
    }
  }
}

setNegotiableQuoteShippingMethods

Assign the shipping methods on the negotiable quote.

Response: SetNegotiableQuoteShippingMethodsOutput

Arguments

Example

Query

mutation setNegotiableQuoteShippingMethods($input: SetNegotiableQuoteShippingMethodsInput!) {
  setNegotiableQuoteShippingMethods(input: $input) {
    quote {
      ...NegotiableQuoteFragment
    }
  }
}

Variables

{"input": SetNegotiableQuoteShippingMethodsInput}

Response

{
  "data": {
    "setNegotiableQuoteShippingMethods": {
      "quote": NegotiableQuote
    }
  }
}

setNegotiableQuoteTemplateShippingAddress

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

Response: NegotiableQuoteTemplate

Arguments

Example

Query

mutation setNegotiableQuoteTemplateShippingAddress($input: SetNegotiableQuoteTemplateShippingAddressInput!) {
  setNegotiableQuoteTemplateShippingAddress(input: $input) {
    buyer {
      ...NegotiableQuoteUserFragment
    }
    comments {
      ...NegotiableQuoteCommentFragment
    }
    expiration_date
    history {
      ...NegotiableQuoteHistoryEntryFragment
    }
    is_min_max_qty_used
    is_virtual
    items {
      ...CartItemInterfaceFragment
    }
    max_order_commitment
    min_order_commitment
    name
    notifications {
      ...QuoteTemplateNotificationMessageFragment
    }
    prices {
      ...CartPricesFragment
    }
    reference_document_links {
      ...NegotiableQuoteReferenceDocumentLinkFragment
    }
    shipping_addresses {
      ...NegotiableQuoteShippingAddressFragment
    }
    status
    template_id
    total_quantity
  }
}

Variables

{"input": SetNegotiableQuoteTemplateShippingAddressInput}

Response

{
  "data": {
    "setNegotiableQuoteTemplateShippingAddress": {
      "buyer": NegotiableQuoteUser,
      "comments": [NegotiableQuoteComment],
      "expiration_date": "xyz789",
      "history": [NegotiableQuoteHistoryEntry],
      "is_min_max_qty_used": true,
      "is_virtual": true,
      "items": [CartItemInterface],
      "max_order_commitment": 987,
      "min_order_commitment": 123,
      "name": "abc123",
      "notifications": [QuoteTemplateNotificationMessage],
      "prices": CartPrices,
      "reference_document_links": [
        NegotiableQuoteReferenceDocumentLink
      ],
      "shipping_addresses": [
        NegotiableQuoteShippingAddress
      ],
      "status": "abc123",
      "template_id": "4",
      "total_quantity": 987.65
    }
  }
}

setPaymentMethodAndPlaceOrder

Deprecated

Should use setPaymentMethodOnCart and placeOrder mutations in single request.

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

Response: PlaceOrderOutput

Arguments

Example

Query

mutation setPaymentMethodAndPlaceOrder($input: SetPaymentMethodAndPlaceOrderInput) {
  setPaymentMethodAndPlaceOrder(input: $input) {
    errors {
      ...PlaceOrderErrorFragment
    }
    order {
      ...OrderFragment
    }
    orderV2 {
      ...CustomerOrderFragment
    }
  }
}

Variables

{"input": SetPaymentMethodAndPlaceOrderInput}

Response

{
  "data": {
    "setPaymentMethodAndPlaceOrder": {
      "errors": [PlaceOrderError],
      "order": Order,
      "orderV2": CustomerOrder
    }
  }
}

setPaymentMethodOnCart

Apply a payment method to the cart.

Response: SetPaymentMethodOnCartOutput

Arguments

Example

Query

mutation setPaymentMethodOnCart($input: SetPaymentMethodOnCartInput) {
  setPaymentMethodOnCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}

Variables

{"input": SetPaymentMethodOnCartInput}

Response

{"data": {"setPaymentMethodOnCart": {"cart": Cart}}}

setQuoteTemplateLineItemNote

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

Response: NegotiableQuoteTemplate

Arguments

Example

Query

mutation setQuoteTemplateLineItemNote($input: QuoteTemplateLineItemNoteInput!) {
  setQuoteTemplateLineItemNote(input: $input) {
    buyer {
      ...NegotiableQuoteUserFragment
    }
    comments {
      ...NegotiableQuoteCommentFragment
    }
    expiration_date
    history {
      ...NegotiableQuoteHistoryEntryFragment
    }
    is_min_max_qty_used
    is_virtual
    items {
      ...CartItemInterfaceFragment
    }
    max_order_commitment
    min_order_commitment
    name
    notifications {
      ...QuoteTemplateNotificationMessageFragment
    }
    prices {
      ...CartPricesFragment
    }
    reference_document_links {
      ...NegotiableQuoteReferenceDocumentLinkFragment
    }
    shipping_addresses {
      ...NegotiableQuoteShippingAddressFragment
    }
    status
    template_id
    total_quantity
  }
}

Variables

{"input": QuoteTemplateLineItemNoteInput}

Response

{
  "data": {
    "setQuoteTemplateLineItemNote": {
      "buyer": NegotiableQuoteUser,
      "comments": [NegotiableQuoteComment],
      "expiration_date": "xyz789",
      "history": [NegotiableQuoteHistoryEntry],
      "is_min_max_qty_used": true,
      "is_virtual": false,
      "items": [CartItemInterface],
      "max_order_commitment": 123,
      "min_order_commitment": 123,
      "name": "xyz789",
      "notifications": [QuoteTemplateNotificationMessage],
      "prices": CartPrices,
      "reference_document_links": [
        NegotiableQuoteReferenceDocumentLink
      ],
      "shipping_addresses": [
        NegotiableQuoteShippingAddress
      ],
      "status": "xyz789",
      "template_id": "4",
      "total_quantity": 123.45
    }
  }
}

setShippingAddressesOnCart

Set one or more shipping addresses on a specific cart.

Response: SetShippingAddressesOnCartOutput

Arguments

Example

Query

mutation setShippingAddressesOnCart($input: SetShippingAddressesOnCartInput) {
  setShippingAddressesOnCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}

Variables

{"input": SetShippingAddressesOnCartInput}

Response

{"data": {"setShippingAddressesOnCart": {"cart": Cart}}}

setShippingMethodsOnCart

Set one or more delivery methods on a cart.

Response: SetShippingMethodsOnCartOutput

Arguments

Example

Query

mutation setShippingMethodsOnCart($input: SetShippingMethodsOnCartInput) {
  setShippingMethodsOnCart(input: $input) {
    cart {
      ...CartFragment
    }
  }
}

Variables

{"input": SetShippingMethodsOnCartInput}

Response

{"data": {"setShippingMethodsOnCart": {"cart": Cart}}}

shareGiftRegistry

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

Response: ShareGiftRegistryOutput

Arguments

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

submitNegotiableQuoteTemplateForReview

Accept an existing negotiable quote template.

Response: NegotiableQuoteTemplate

Arguments

Example

Query

mutation submitNegotiableQuoteTemplateForReview($input: SubmitNegotiableQuoteTemplateForReviewInput!) {
  submitNegotiableQuoteTemplateForReview(input: $input) {
    buyer {
      ...NegotiableQuoteUserFragment
    }
    comments {
      ...NegotiableQuoteCommentFragment
    }
    expiration_date
    history {
      ...NegotiableQuoteHistoryEntryFragment
    }
    is_min_max_qty_used
    is_virtual
    items {
      ...CartItemInterfaceFragment
    }
    max_order_commitment
    min_order_commitment
    name
    notifications {
      ...QuoteTemplateNotificationMessageFragment
    }
    prices {
      ...CartPricesFragment
    }
    reference_document_links {
      ...NegotiableQuoteReferenceDocumentLinkFragment
    }
    shipping_addresses {
      ...NegotiableQuoteShippingAddressFragment
    }
    status
    template_id
    total_quantity
  }
}

Variables

{"input": SubmitNegotiableQuoteTemplateForReviewInput}

Response

{
  "data": {
    "submitNegotiableQuoteTemplateForReview": {
      "buyer": NegotiableQuoteUser,
      "comments": [NegotiableQuoteComment],
      "expiration_date": "xyz789",
      "history": [NegotiableQuoteHistoryEntry],
      "is_min_max_qty_used": true,
      "is_virtual": false,
      "items": [CartItemInterface],
      "max_order_commitment": 987,
      "min_order_commitment": 123,
      "name": "abc123",
      "notifications": [QuoteTemplateNotificationMessage],
      "prices": CartPrices,
      "reference_document_links": [
        NegotiableQuoteReferenceDocumentLink
      ],
      "shipping_addresses": [
        NegotiableQuoteShippingAddress
      ],
      "status": "xyz789",
      "template_id": 4,
      "total_quantity": 987.65
    }
  }
}

subscribeEmailToNewsletter

Subscribe the specified email to the store's newsletter.

Response: SubscribeEmailToNewsletterOutput

Arguments

Example

Query

mutation subscribeEmailToNewsletter($email: String!) {
  subscribeEmailToNewsletter(email: $email) {
    status
  }
}

Variables

{"email": "xyz789"}

Response

{"data": {"subscribeEmailToNewsletter": {"status": "NOT_ACTIVE"}}}

syncPaymentOrder

Synchronizes the payment order details for further payment processing

Response: Boolean

Arguments

Example

Query

mutation syncPaymentOrder($input: SyncPaymentOrderInput) {
  syncPaymentOrder(input: $input)
}

Variables

{"input": SyncPaymentOrderInput}

Response

{"data": {"syncPaymentOrder": true}}

trackViewedProduct

Track that a product was viewed in adobe commerce

Response: Boolean

Arguments

Example

Query

mutation trackViewedProduct($sku: String!) {
  trackViewedProduct(sku: $sku)
}

Variables

{"sku": "abc123"}

Response

{"data": {"trackViewedProduct": true}}

updateCartItems

Modify items in the cart.

Response: UpdateCartItemsOutput

Arguments

Example

Query

mutation updateCartItems($input: UpdateCartItemsInput) {
  updateCartItems(input: $input) {
    cart {
      ...CartFragment
    }
    errors {
      ...CartUserInputErrorFragment
    }
  }
}

Variables

{"input": UpdateCartItemsInput}

Response

{
  "data": {
    "updateCartItems": {
      "cart": Cart,
      "errors": [CartUserInputError]
    }
  }
}

updateCompany

Update company information.

Response: UpdateCompanyOutput

Arguments

Example

Query

mutation updateCompany($input: CompanyUpdateInput!) {
  updateCompany(input: $input) {
    company {
      ...CompanyFragment
    }
  }
}

Variables

{"input": CompanyUpdateInput}

Response

{"data": {"updateCompany": {"company": Company}}}

updateCompanyRole

Update company role information.

Response: UpdateCompanyRoleOutput

Arguments

Example

Query

mutation updateCompanyRole($input: CompanyRoleUpdateInput!) {
  updateCompanyRole(input: $input) {
    role {
      ...CompanyRoleFragment
    }
  }
}

Variables

{"input": CompanyRoleUpdateInput}

Response

{"data": {"updateCompanyRole": {"role": CompanyRole}}}

updateCompanyStructure

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

Response: UpdateCompanyStructureOutput

Arguments

Example

Query

mutation updateCompanyStructure($input: CompanyStructureUpdateInput!) {
  updateCompanyStructure(input: $input) {
    company {
      ...CompanyFragment
    }
  }
}

Variables

{"input": CompanyStructureUpdateInput}

Response

{"data": {"updateCompanyStructure": {"company": Company}}}

updateCompanyTeam

Update company team data.

Response: UpdateCompanyTeamOutput

Arguments

Example

Query

mutation updateCompanyTeam($input: CompanyTeamUpdateInput!) {
  updateCompanyTeam(input: $input) {
    team {
      ...CompanyTeamFragment
    }
  }
}

Variables

{"input": CompanyTeamUpdateInput}

Response

{"data": {"updateCompanyTeam": {"team": CompanyTeam}}}

updateCompanyUser

Update an existing company user.

Response: UpdateCompanyUserOutput

Arguments

Example

Query

mutation updateCompanyUser($input: CompanyUserUpdateInput!) {
  updateCompanyUser(input: $input) {
    user {
      ...CustomerFragment
    }
  }
}

Variables

{"input": CompanyUserUpdateInput}

Response

{"data": {"updateCompanyUser": {"user": Customer}}}

updateCustomer

Deprecated

Use updateCustomerV2 instead.

Response: CustomerOutput

Arguments

Example

Query

mutation updateCustomer($input: CustomerInput!) {
  updateCustomer(input: $input) {
    customer {
      ...CustomerFragment
    }
  }
}

Variables

{"input": CustomerInput}

Response

{"data": {"updateCustomer": {"customer": Customer}}}

updateCustomerAddress

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

Response: CustomerAddress

Arguments

Example

Query

mutation updateCustomerAddress(
  $id: Int!,
  $input: CustomerAddressInput
) {
  updateCustomerAddress(
    id: $id,
    input: $input
  ) {
    city
    company
    country_code
    country_id
    custom_attributes {
      ...CustomerAddressAttributeFragment
    }
    custom_attributesV2 {
      ...AttributeValueInterfaceFragment
    }
    customer_id
    default_billing
    default_shipping
    extension_attributes {
      ...CustomerAddressAttributeFragment
    }
    fax
    firstname
    id
    lastname
    middlename
    postcode
    prefix
    region {
      ...CustomerAddressRegionFragment
    }
    region_id
    street
    suffix
    telephone
    vat_id
  }
}

Variables

{"id": 987, "input": CustomerAddressInput}

Response

{
  "data": {
    "updateCustomerAddress": {
      "city": "xyz789",
      "company": "xyz789",
      "country_code": "AF",
      "country_id": "abc123",
      "custom_attributes": [CustomerAddressAttribute],
      "custom_attributesV2": [AttributeValueInterface],
      "customer_id": 987,
      "default_billing": false,
      "default_shipping": true,
      "extension_attributes": [CustomerAddressAttribute],
      "fax": "abc123",
      "firstname": "xyz789",
      "id": 987,
      "lastname": "xyz789",
      "middlename": "abc123",
      "postcode": "abc123",
      "prefix": "xyz789",
      "region": CustomerAddressRegion,
      "region_id": 123,
      "street": ["xyz789"],
      "suffix": "xyz789",
      "telephone": "xyz789",
      "vat_id": "abc123"
    }
  }
}

updateCustomerEmail

Change the email address for the logged-in customer.

Response: CustomerOutput

Arguments

Example

Query

mutation updateCustomerEmail(
  $email: String!,
  $password: String!
) {
  updateCustomerEmail(
    email: $email,
    password: $password
  ) {
    customer {
      ...CustomerFragment
    }
  }
}

Variables

{
  "email": "xyz789",
  "password": "xyz789"
}

Response

{"data": {"updateCustomerEmail": {"customer": Customer}}}

updateCustomerV2

Update the customer's personal information.

Response: CustomerOutput

Arguments

Example

Query

mutation updateCustomerV2($input: CustomerUpdateInput!) {
  updateCustomerV2(input: $input) {
    customer {
      ...CustomerFragment
    }
  }
}

Variables

{"input": CustomerUpdateInput}

Response

{"data": {"updateCustomerV2": {"customer": Customer}}}

updateGiftRegistry

Update the specified gift registry.

Response: UpdateGiftRegistryOutput

Arguments

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

updateGiftRegistryItems

Update the specified items in the gift registry.

Response: UpdateGiftRegistryItemsOutput

Arguments

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

updateGiftRegistryRegistrants

Modify the properties of one or more gift registry registrants.

Response: UpdateGiftRegistryRegistrantsOutput

Arguments

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

updateNegotiableQuoteQuantities

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

Response: UpdateNegotiableQuoteItemsQuantityOutput

Arguments

Example

Query

mutation updateNegotiableQuoteQuantities($input: UpdateNegotiableQuoteQuantitiesInput!) {
  updateNegotiableQuoteQuantities(input: $input) {
    quote {
      ...NegotiableQuoteFragment
    }
  }
}

Variables

{"input": UpdateNegotiableQuoteQuantitiesInput}

Response

{
  "data": {
    "updateNegotiableQuoteQuantities": {
      "quote": NegotiableQuote
    }
  }
}

updateNegotiableQuoteTemplateQuantities

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

Response: UpdateNegotiableQuoteTemplateItemsQuantityOutput

Arguments

Example

Query

mutation updateNegotiableQuoteTemplateQuantities($input: UpdateNegotiableQuoteTemplateQuantitiesInput!) {
  updateNegotiableQuoteTemplateQuantities(input: $input) {
    quote_template {
      ...NegotiableQuoteTemplateFragment
    }
  }
}

Variables

{"input": UpdateNegotiableQuoteTemplateQuantitiesInput}

Response

{
  "data": {
    "updateNegotiableQuoteTemplateQuantities": {
      "quote_template": NegotiableQuoteTemplate
    }
  }
}

updateProductsInWishlist

Update one or more products in the specified wish list.

Response: UpdateProductsInWishlistOutput

Arguments

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

updatePurchaseOrderApprovalRule

Update existing purchase order approval rules.

Response: PurchaseOrderApprovalRule

Arguments

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": "abc123",
      "description": "xyz789",
      "name": "xyz789",
      "status": "ENABLED",
      "uid": 4,
      "updated_at": "abc123"
    }
  }
}

updateRequisitionList

Rename a requisition list and change its description.

Response: UpdateRequisitionListOutput

Arguments

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

updateRequisitionListItems

Update items in a requisition list.

Response: UpdateRequisitionListItemsOutput

Arguments

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

updateWishlist

Change the name and visibility of the specified wish list.

Response: UpdateWishlistOutput

Arguments

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

validatePurchaseOrders

Validate purchase orders.

Response: ValidatePurchaseOrdersOutput

Arguments

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