data-src=../../../../includes/paas-only.md

addDownloadableProductsToCart mutation

data-variant=warning

data-slots=text

A downloadable product can be anything that you can deliver as a file, such as an eBook, music, video, software application, or an update. To add a downloadable product to a cart, you must provide the cart ID, the SKU, and the quantity. In some cases, you must include the IDs for downloadable product links. You can also optionally specify customizable options.

Syntax

mutation: {
    addDownloadableProductsToCart(
        input: AddDownloadableProductsToCartInput
    ): {
        AddDownloadableProductsToCartOutput
    }
}

Reference

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

Example usage

The following examples show how to add a downloadable product to a shopping cart , depending on whether the Links can be purchased separately option is selected on the Downloadable Information section of the product page.

Add a downloadable product to a cart with Links can be purchased separately enabled

The following example shows how to add a downloadable product in which the Links can be purchased separately option is enabled. The payload includes custom downloadable links Episode 2 and Episode 3.

Request:

mutation {
  addDownloadableProductsToCart(
    input: {
      cart_id: "gMV2BFQuNGiQmTnepQlMGko7Xc4P3X1w"
      cart_items: {
        data: {
          sku: "240-LV09"
          quantity: 1
        }
        downloadable_product_links: [
          {
            link_id: 7                 # Episode 2
          }
          {
            link_id: 8                 # Episode 3
          }
        ]
      }
    }
  ) {
    cart {
      itemsV2 {
        items {
          product {
            sku
          }
          quantity
          ... on DownloadableCartItem {
            links {
              title
              price
            }
            samples {
              title
              sample_url
            }
          }
        }
        total_count
        page_info {
          page_size
          current_page
          total_pages
        }
      }
    }
  }
}

Response:

{
  "data": {
    "addDownloadableProductsToCart": {
      "cart": {
        "itemsV2": {
          "items": [
            {
              "product": {
                "sku": "240-LV09"
              },
              "quantity": 1,
              "links": [
                {
                  "title": "Episode 2",
                  "price": 9
                },
                {
                  "title": "Episode 3",
                  "price": 9
                }
              ],
              "samples": [
                {
                  "title": "Trailer #1",
                  "sample_url": "https://<M2_INSTANCE>/downloadable/download/sample/sample_id/16/"
                },
                {
                  "title": "Trailer #2",
                  "sample_url": "https://<M2_INSTANCE>/downloadable/download/sample/sample_id/17/"
                },
                {
                  "title": "Trailer #3",
                  "sample_url": "https://<M2_INSTANCE>/downloadable/download/sample/sample_id/18/"
                }
              ]
            }
          ],
          "total_count": 1,
          "page_info": {
            "page_size": 20,
            "current_page": 1,
            "total_pages": 1
          }
        }
      }
    }
  }
}

Add a downloadable product to a cart with disabled Links can be purchased separately

The following example shows how to add a downloadable product in which the Links can be purchased separately option is disabled. All downloadable links are added to the cart automatically.

Request:

mutation {
  addDownloadableProductsToCart(
    input: {
      cart_id: "gMV2BFQuNGiQmTnepQlMGko7Xc4P3X1w"
      cart_items: {
        data: {
          sku: "240-LV07"
          quantity: 1
        }
      }
    }
  ) {
    cart {
      itemsV2 {
        items {
          product {
            sku
          }
          quantity
          ... on DownloadableCartItem {
            links {
              title
              price
            }
            samples {
              title
              sample_url
            }
          }
        }
        total_count
        page_info {
          page_size
          current_page
          total_pages
        }
      }
    }
  }
}

Response:

{
  "data": {
    "addDownloadableProductsToCart": {
      "cart": {
        "itemsV2": {
          "items": [
            {
              "product": {
                "sku": "240-LV07"
              },
              "quantity": 2,
              "links": [
                {
                  "title": "Solo Power Circuit",
                  "price": 14
                }
              ],
              "samples": [
                {
                  "title": "Trailer #1",
                  "sample_url": "https://<M2_INSTANCE>/downloadable/download/sample/sample_id/10/"
                },
                {
                  "title": "Trailer #2",
                  "sample_url": "https://<M2_INSTANCE>/downloadable/download/sample/sample_id/11/"
                },
                {
                  "title": "Trailer #3",
                  "sample_url": "https://<M2_INSTANCE>/downloadable/download/sample/sample_id/12/"
                }
              ]
            }
          ],
          "total_count": 1,
          "page_info": {
            "page_size": 20,
            "current_page": 1,
            "total_pages": 1
          }          
        }
      }
    }
  }
}

Errors

data-slots=text

data-backgroundcolor=gray