assignCustomerToGuestCart mutation

The assignCustomerToGuestCart mutation merges a logged-in customer's shopping cart into the specified guest cart. The mutation inactivates the customer's shopping cart and moves the products to the guest cart. The guest cart is then assigned to the customer.

This mutation requires a valid customer authentication token.

Syntax

Copy
mutation {
    assignCustomerToGuestCart(
        cart_id: String!
    ) {
        Cart!
    }
}
Copied to your clipboard
mutation {
    assignCustomerToGuestCart(
        cart_id: String!
    ) {
        Cart!
    }
}

Reference

The assignCustomerToGuestCart reference provides detailed information about the types and fields defined in this mutation.

Example usage

In the following example, the customer and guest carts each contain one item. The mutation merges the customer's cart to the guest cart. As a result, the guest cart contains two items.

Request:

Copy
mutation {
  assignCustomerToGuestCart(
    cart_id: "MDYKgqIdWMKr7VD1zlYwxrB7kuX8lR5s"
  ) {
    itemsV2 {
      items {
        quantity
        product {
          sku
        }
      }
      total_count
      page_info {
        page_size
        current_page
        total_pages
      }
    }
  }
}
Copied to your clipboard
mutation {
  assignCustomerToGuestCart(
    cart_id: "MDYKgqIdWMKr7VD1zlYwxrB7kuX8lR5s"
  ) {
    itemsV2 {
      items {
        quantity
        product {
          sku
        }
      }
      total_count
      page_info {
        page_size
        current_page
        total_pages
      }
    }
  }
}

Response:

Copy
{
  "data": {
    "assignCustomerToGuestCart": {
      "itemsV2": {
        "items": [
          {
            "quantity": 1,
            "product": {
              "sku": "customer_item"
            }
          },
          {
            "quantity": 1,
            "product": {
              "sku": "guest_item"
            }
          }
        ],
        "total_count": 1,
        "page_info": {
          "page_size": 20,
          "current_page": 1,
          "total_pages": 1
        }
      }
    }
  }
}
Copied to your clipboard
{
  "data": {
    "assignCustomerToGuestCart": {
      "itemsV2": {
        "items": [
          {
            "quantity": 1,
            "product": {
              "sku": "customer_item"
            }
          },
          {
            "quantity": 1,
            "product": {
              "sku": "guest_item"
            }
          }
        ],
        "total_count": 1,
        "page_info": {
          "page_size": 20,
          "current_page": 1,
          "total_pages": 1
        }
      }
    }
  }
}

Errors

Last updated 3/14/2024

Was this helpful?

Yes

No