combinedListingUpdate

mutation

Requires write_products access scope. Also: The user must have permission to manage products.

Add, remove and update CombinedListings of a given Product.

CombinedListings are comprised of multiple products to create a single listing. There are two kinds of products used in a CombinedListing:

Parent products
Child products

The parent product is created with a productCreate with a CombinedListingRole of PARENT. Once created, you can associate child products with the parent product using this mutation. Parent products represent the idea of a product (e.g. Shoe).

Child products represent a particular option value (or combination of option values) of a parent product. For instance, with your Shoe parent product, you may have several child products representing specific colors of the shoe (e.g. Shoe - Blue). You could also have child products representing more than a single option (e.g. Shoe - Blue/Canvas, Shoe - Blue/Leather, etc...).

The combined listing is the association of parent product to one or more child products.

Learn more about Combined Listings.

Arguments

Anchor to optionsAndValuesoptionsAndValues • [OptionAndValueInput!]: The ordered options and values to be used by the combined listing. Options and values will be reordered to match the order specified here.
Anchor to parentProductIdparentProductId • ID!required: The ID of the parent product.
Anchor to productsAddedproductsAdded • [ChildProductRelationInput!]: The child products to add and their assigned options and option values.
Anchor to productsEditedproductsEdited • [ChildProductRelationInput!]: The child products to edit and their assigned options and option values.
Anchor to productsRemovedIdsproductsRemovedIds • [ID!]: The IDs of products to be removed from the combined listing.
Anchor to titletitle • String: The updated title for the combined listing.

Was this section helpful?

Anchor to CombinedListingUpdatePayload returnsCombinedListingUpdatePayload returns

Anchor to productproduct • Product: The parent product.
Anchor to userErrorsuserErrors • [CombinedListingUpdateUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Add child products to a combined listing
Remove child products from a combined listing
Update option values of combined listing child product
combinedListingUpdate reference

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation AddChildProductsToCombinedListing($parentProductId: ID!, $productsAdded: [ChildProductRelationInput!], $optionsAndValues: [OptionAndValueInput!]) {
6    combinedListingUpdate(parentProductId: $parentProductId, productsAdded: $productsAdded, optionsAndValues: $optionsAndValues) {
7      product {
8        id
9        combinedListing {
10          combinedListingChildren(first: 10) {
11            nodes {
12              product {
13                id
14              }
15              parentVariant {
16                selectedOptions {
17                  value
18                }
19              }
20            }
21          }
22        }
23      }
24      userErrors {
25        code
26        field
27        message
28      }
29    }
30  }`,
31  {
32    variables: {
33      "parentProductId": "gid://shopify/Product/108828309",
34      "productsAdded": [
35        {
36          "childProductId": "gid://shopify/Product/121709582",
37          "selectedParentOptionValues": [
38            {
39              "name": "color",
40              "value": "Blue"
41            },
42            {
43              "name": "size",
44              "value": "12"
45            }
46          ]
47        },
48        {
49          "childProductId": "gid://shopify/Product/912855135",
50          "selectedParentOptionValues": [
51            {
52              "name": "color",
53              "value": "Red"
54            },
55            {
56              "name": "size",
57              "value": "12"
58            }
59          ]
60        }
61      ],
62      "optionsAndValues": [
63        {
64          "name": "color",
65          "values": [
66            "Blue",
67            "Red"
68          ]
69        },
70        {
71          "name": "size",
72          "values": [
73            "12"
74          ]
75        }
76      ]
77    },
78  },
79);
80
81const data = await response.json();
82

mutation AddChildProductsToCombinedListing($parentProductId: ID!, $productsAdded: [ChildProductRelationInput!], $optionsAndValues: [OptionAndValueInput!]) {
  combinedListingUpdate(parentProductId: $parentProductId, productsAdded: $productsAdded, optionsAndValues: $optionsAndValues) {
    product {
      id
      combinedListing {
        combinedListingChildren(first: 10) {
          nodes {
            product {
              id
            }
            parentVariant {
              selectedOptions {
                value
              }
            }
          }
        }
      }
    }
    userErrors {
      code
      field
      message
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation AddChildProductsToCombinedListing($parentProductId: ID!, $productsAdded: [ChildProductRelationInput!], $optionsAndValues: [OptionAndValueInput!]) { combinedListingUpdate(parentProductId: $parentProductId, productsAdded: $productsAdded, optionsAndValues: $optionsAndValues) { product { id combinedListing { combinedListingChildren(first: 10) { nodes { product { id } parentVariant { selectedOptions { value } } } } } } userErrors { code field message } } }",
 "variables": {
    "parentProductId": "gid://shopify/Product/108828309",
    "productsAdded": [
      {
        "childProductId": "gid://shopify/Product/121709582",
        "selectedParentOptionValues": [
          {
            "name": "color",
            "value": "Blue"
          },
          {
            "name": "size",
            "value": "12"
          }
        ]
      },
      {
        "childProductId": "gid://shopify/Product/912855135",
        "selectedParentOptionValues": [
          {
            "name": "color",
            "value": "Red"
          },
          {
            "name": "size",
            "value": "12"
          }
        ]
      }
    ],
    "optionsAndValues": [
      {
        "name": "color",
        "values": [
          "Blue",
          "Red"
        ]
      },
      {
        "name": "size",
        "values": [
          "12"
        ]
      }
    ]
  }
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  mutation AddChildProductsToCombinedListing($parentProductId: ID!, $productsAdded: [ChildProductRelationInput!], $optionsAndValues: [OptionAndValueInput!]) {
    combinedListingUpdate(parentProductId: $parentProductId, productsAdded: $productsAdded, optionsAndValues: $optionsAndValues) {
      product {
        id
        combinedListing {
          combinedListingChildren(first: 10) {
            nodes {
              product {
                id
              }
              parentVariant {
                selectedOptions {
                  value
                }
              }
            }
          }
        }
      }
      userErrors {
        code
        field
        message
      }
    }
  }`,
  {
    variables: {
      "parentProductId": "gid://shopify/Product/108828309",
      "productsAdded": [
        {
          "childProductId": "gid://shopify/Product/121709582",
          "selectedParentOptionValues": [
            {
              "name": "color",
              "value": "Blue"
            },
            {
              "name": "size",
              "value": "12"
            }
          ]
        },
        {
          "childProductId": "gid://shopify/Product/912855135",
          "selectedParentOptionValues": [
            {
              "name": "color",
              "value": "Red"
            },
            {
              "name": "size",
              "value": "12"
            }
          ]
        }
      ],
      "optionsAndValues": [
        {
          "name": "color",
          "values": [
            "Blue",
            "Red"
          ]
        },
        {
          "name": "size",
          "values": [
            "12"
          ]
        }
      ]
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation AddChildProductsToCombinedListing($parentProductId: ID!, $productsAdded: [ChildProductRelationInput!], $optionsAndValues: [OptionAndValueInput!]) {
      combinedListingUpdate(parentProductId: $parentProductId, productsAdded: $productsAdded, optionsAndValues: $optionsAndValues) {
        product {
          id
          combinedListing {
            combinedListingChildren(first: 10) {
              nodes {
                product {
                  id
                }
                parentVariant {
                  selectedOptions {
                    value
                  }
                }
              }
            }
          }
        }
        userErrors {
          code
          field
          message
        }
      }
    }`,
    "variables": {
      "parentProductId": "gid://shopify/Product/108828309",
      "productsAdded": [
        {
          "childProductId": "gid://shopify/Product/121709582",
          "selectedParentOptionValues": [
            {
              "name": "color",
              "value": "Blue"
            },
            {
              "name": "size",
              "value": "12"
            }
          ]
        },
        {
          "childProductId": "gid://shopify/Product/912855135",
          "selectedParentOptionValues": [
            {
              "name": "color",
              "value": "Red"
            },
            {
              "name": "size",
              "value": "12"
            }
          ]
        }
      ],
      "optionsAndValues": [
        {
          "name": "color",
          "values": [
            "Blue",
            "Red"
          ]
        },
        {
          "name": "size",
          "values": [
            "12"
          ]
        }
      ]
    },
  },
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation AddChildProductsToCombinedListing($parentProductId: ID!, $productsAdded: [ChildProductRelationInput!], $optionsAndValues: [OptionAndValueInput!]) {
    combinedListingUpdate(parentProductId: $parentProductId, productsAdded: $productsAdded, optionsAndValues: $optionsAndValues) {
      product {
        id
        combinedListing {
          combinedListingChildren(first: 10) {
            nodes {
              product {
                id
              }
              parentVariant {
                selectedOptions {
                  value
                }
              }
            }
          }
        }
      }
      userErrors {
        code
        field
        message
      }
    }
  }
QUERY

variables = {
  "parentProductId": "gid://shopify/Product/108828309",
  "productsAdded": [{"childProductId"=>"gid://shopify/Product/121709582", "selectedParentOptionValues"=>[{"name"=>"color", "value"=>"Blue"}, {"name"=>"size", "value"=>"12"}]}, {"childProductId"=>"gid://shopify/Product/912855135", "selectedParentOptionValues"=>[{"name"=>"color", "value"=>"Red"}, {"name"=>"size", "value"=>"12"}]}],
  "optionsAndValues": [{"name"=>"color", "values"=>["Blue", "Red"]}, {"name"=>"size", "values"=>["12"]}]
}

response = client.query(query: query, variables: variables)

Input variables

JSON

1{
2  "parentProductId": "gid://shopify/Product/108828309",
3  "productsAdded": [
4    {
5      "childProductId": "gid://shopify/Product/121709582",
6      "selectedParentOptionValues": [
7        {
8          "name": "color",
9          "value": "Blue"
10        },
11        {
12          "name": "size",
13          "value": "12"
14        }
15      ]
16    },
17    {
18      "childProductId": "gid://shopify/Product/912855135",
19      "selectedParentOptionValues": [
20        {
21          "name": "color",
22          "value": "Red"
23        },
24        {
25          "name": "size",
26          "value": "12"
27        }
28      ]
29    }
30  ],
31  "optionsAndValues": [
32    {
33      "name": "color",
34      "values": [
35        "Blue",
36        "Red"
37      ]
38    },
39    {
40      "name": "size",
41      "values": [
42        "12"
43      ]
44    }
45  ]
46}

Response

JSON

1{
2  "combinedListingUpdate": {
3    "product": {
4      "id": "gid://shopify/Product/108828309",
5      "combinedListing": {
6        "combinedListingChildren": {
7          "nodes": [
8            {
9              "product": {
10                "id": "gid://shopify/Product/121709582"
11              },
12              "parentVariant": {
13                "selectedOptions": [
14                  {
15                    "value": "Blue"
16                  },
17                  {
18                    "value": "12"
19                  }
20                ]
21              }
22            },
23            {
24              "product": {
25                "id": "gid://shopify/Product/912855135"
26              },
27              "parentVariant": {
28                "selectedOptions": [
29                  {
30                    "value": "Red"
31                  },
32                  {
33                    "value": "12"
34                  }
35                ]
36              }
37            }
38          ]
39        }
40      }
41    },
42    "userErrors": []
43  }
44}