assignCompareListToCustomer mutation

The assignCompareListToCustomer mutation assigns the specified comparison list to the logged-in customer. Use this mutation when a customer creates a comparison list as a guest, but subsequently logs in.

This mutation requires a valid customer authentication token.

Syntax

Copy
mutation {
    assignCompareListToCustomer(
        uid: ID!
    ) {
        AssignCompareListToCustomerOutput
    }
}
Copied to your clipboard
mutation {
    assignCompareListToCustomer(
        uid: ID!
    ) {
        AssignCompareListToCustomerOutput
    }
}

Reference

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

Example usage

The following example assigns the comparison list with a uid value of sssXyGZkTFksdPnxNoK1ut6OiV4bbchD to the logged-in customer.

Request:

Copy
mutation {
    assignCompareListToCustomer(
        uid: "sssXyGZkTFksdPnxNoK1ut6OiV4bbchD",
    ) {
        result
        compare_list {
            uid
            item_count
            attributes {
                code
                label
            }
            items {
                uid
                product {
                    sku
                    name
                    description {
                        html
                    }
                }
            }
        }
    }
}
Copied to your clipboard
mutation {
    assignCompareListToCustomer(
        uid: "sssXyGZkTFksdPnxNoK1ut6OiV4bbchD",
    ) {
        result
        compare_list {
            uid
            item_count
            attributes {
                code
                label
            }
            items {
                uid
                product {
                    sku
                    name
                    description {
                        html
                    }
                }
            }
        }
    }
}

Response:

Copy
{
    "data": {
        "assignCompareListToCustomer": {
            "result": true,
            "compare_list": {
                "uid": "sssXyGZkTFksdPnxNoK1ut6OiV4bbchD",
                "item_count": 2,
                "attributes": [
                    {
                        "code": "sku",
                        "label": "SKU"
                    },
                    {
                        "code": "description",
                        "label": "Description"
                    },
                    {
                        "code": "short_description",
                        "label": "Short Description"
                    },
                    {
                        "code": "activity",
                        "label": "Activity"
                    }
                ],
                "items": [
                    {
                        "uid": "3",
                        "product": {
                            "sku": "24-MB03",
                            "name": "Crown Summit Backpack",
                            "description": {
                                "html": "<p>The Crown Summit Backpack is equally at home in a gym locker, study cube or a pup tent, so be sure yours is packed with books, a bag lunch, water bottles, yoga block, laptop, or whatever else you want in hand. Rugged enough for day hikes and camping trips, it has two large zippered compartments and padded, adjustable shoulder straps.</p>\n<ul>\n<li>Top handle.</li>\n<li>Grommet holes.</li>\n<li>Two-way zippers.</li>\n<li>H 20\" x W 14\" x D 12\".</li>\n<li>Weight: 2 lbs, 8 oz. Volume: 29 L.</li>\n<ul>"
                            }
                        }
                    },
                    {
                        "uid": "4",
                        "product": {
                            "sku": "24-MB05",
                            "name": "Wayfarer Messenger Bag",
                            "description": {
                                "html": "<p>Perfect for class, work or the gym, the Wayfarer Messenger Bag is packed with pockets. The dual-buckle flap closure reveals an organizational panel, and the roomy main compartment has spaces for your laptop and a change of clothes. An adjustable shoulder strap and easy-grip handle promise easy carrying.</p>\n<ul>\n<li>Multiple internal zip pockets.</li>\n<li>Made of durable nylon.</li>\n</ul>"
                            }
                        }
                    }
                ]
            }
        }
    }
}
Copied to your clipboard
{
    "data": {
        "assignCompareListToCustomer": {
            "result": true,
            "compare_list": {
                "uid": "sssXyGZkTFksdPnxNoK1ut6OiV4bbchD",
                "item_count": 2,
                "attributes": [
                    {
                        "code": "sku",
                        "label": "SKU"
                    },
                    {
                        "code": "description",
                        "label": "Description"
                    },
                    {
                        "code": "short_description",
                        "label": "Short Description"
                    },
                    {
                        "code": "activity",
                        "label": "Activity"
                    }
                ],
                "items": [
                    {
                        "uid": "3",
                        "product": {
                            "sku": "24-MB03",
                            "name": "Crown Summit Backpack",
                            "description": {
                                "html": "<p>The Crown Summit Backpack is equally at home in a gym locker, study cube or a pup tent, so be sure yours is packed with books, a bag lunch, water bottles, yoga block, laptop, or whatever else you want in hand. Rugged enough for day hikes and camping trips, it has two large zippered compartments and padded, adjustable shoulder straps.</p>\n<ul>\n<li>Top handle.</li>\n<li>Grommet holes.</li>\n<li>Two-way zippers.</li>\n<li>H 20\" x W 14\" x D 12\".</li>\n<li>Weight: 2 lbs, 8 oz. Volume: 29 L.</li>\n<ul>"
                            }
                        }
                    },
                    {
                        "uid": "4",
                        "product": {
                            "sku": "24-MB05",
                            "name": "Wayfarer Messenger Bag",
                            "description": {
                                "html": "<p>Perfect for class, work or the gym, the Wayfarer Messenger Bag is packed with pockets. The dual-buckle flap closure reveals an organizational panel, and the roomy main compartment has spaces for your laptop and a change of clothes. An adjustable shoulder strap and easy-grip handle promise easy carrying.</p>\n<ul>\n<li>Multiple internal zip pockets.</li>\n<li>Made of durable nylon.</li>\n</ul>"
                            }
                        }
                    }
                ]
            }
        }
    }
}

Related topics

• compareList query
• addProductsToCompareList mutation
• createCompareList mutation
• deleteCompareList mutation
• removeProductsFromCompareList mutation

Last updated 11/27/2023

Was this helpful?

Yes

No