> ## Documentation Index > Fetch the complete documentation index at: https://cloudinary.com/documentation/llms.txt > Use this file to discover all available pages before exploring further. # Magento (Adobe Commerce) product catalog API You can use the Cloudinary product catalog API to programmatically link your Cloudinary media to your Magento (Adobe Commerce) products by providing the URL and product SKU. For example, if you have existing media assets with Cloudinary, you can use the product catalog API to add these to your product listing pages in bulk. You can also retrieve all media linked to a specific SKU or set of SKUs. ## Configuration To configure the API, ensure you have the Cloudinary plugin installed. The API is built on top of the Magento 2 REST API and therefore you'll need to create a new integration in order to allow access to edit the product catalog via the API. To create the integration: 1. In the Magento Admin Panel, select **System** > **Integrations**. 2. Select **Add New Integration.** 3. In the **Integration Info** tab, enter the relevant information as well as your username and password. 4. In the **API** tab, under **Catalog** > **Inventory** > **Products** select the options **Mass Update Attributes**, **Edit Product Design** and **Edit Category Design** to give the integration access to edit the product media.![Magento API config](https://cloudinary-res.cloudinary.com/image/upload/q_auto,f_auto/docs/magento_api_config.png "thumb: w_400,dpr_2, width: 400") 5. Once added, select **Activate** and allow access to the selected APIs. 6. Retrieve your **Access Token**, you will use this to authenticate your requests to the API. ## Authentication The API uses **Bearer Authentication**. Send the token you retrieved when creating your new integration. For example: ``` Authorization: Bearer abc123mytoken123 ``` The `Content-Type` header is also required for all requests. This will always be `application/json`. For example: ``` Content-Type: application/json ``` ## Endpoints As the API is built on top of the Magento REST API, the base URL is the same: `https://{MAGENTO_HOST_OR_IP}/{MAGENTO_BASE_INSTALL_DIR}/rest/V1` The Cloudinary plugin creates four new endpoints: Method | Description ---|--- GETcloudinary/products/:sku/media | [Get media for a specific SKU](#get_media_for_a_specific_sku) POSTcloudinary/products/media/get | [Get media for multiple SKUs](#get_media_for_multiple_skus) POSTcloudinary/products/:sku/media | [Add media to a SKU](#add_media_to_a_sku) POSTcloudinary/productGallery/addItems | [Add media for multiple SKUs](#add_media_for_multiple_skus) > **TIP**: You can use GraphQL to retrieve specific product details from Cloudinary and utilize that information within Magento. For more information, see [Magento (Adobe Commerce) GraphQL queries](magento_graphql_queries). ## Get media for a specific SKU Lists all media asset URLs for the specified SKU. ### Syntax `GET /cloudinary/products/:sku/media` ### Parameters Parameter|Type|Description --- |--- |--- sku|String|**Required**. The product SKU to return media for. ### Example Get media assets for product SKU "my-product-sku": ```curl curl https://my-magento-shop.com/rest/V1/cloudinary/products/my-product-sku/media \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ' \ ``` ### Sample response The response is returned as stringified JSON: ```json "{\"data\":{\"image\":\"https:\\/\\/res.cloudinary.com\\/myMagentoCloud\\/image\\/upload\\/c_lpad,d_sample.jpg,dpr_2.0,f_auto,q_auto\\/v1\\/media\\/catalog\\/product\\/w\\/t\\/my-product-sku_main_1.jpg\",\"small_image\":\"https:\\/\\/res.cloudinary.com\\/myMagentoCloud\\/image\\/upload\\/c_lpad,d_sample.jpg,dpr_2.0,f_auto,q_auto\\/v1\\/media\\/catalog\\/product\\/w\\/t\\/my-product-sku_main_1.jpg\",\"thumbnail\":\"https:\\/\\/res.cloudinary.com\\/myMagentoCloud\\/image\\/upload\\/c_lpad,d_sample.jpg,dpr_2.0,f_auto,q_auto\\/v1\\/media\\/catalog\\/product\\/w\\/t\\/my-product-sku_main_1.jpg\",\"media_gallery\":[\"https:\\/\\/res.cloudinary.com\\/myMagentoCloud\\/image\\/upload\\/c_lpad,d_sample.jpg,dpr_2.0,f_auto,q_auto\\/v1\\/media\\/catalog\\/product\\/w\\/t\\/my-product-sku_main_1.jpg\"]}}" ``` ## Get media for multiple SKUs Lists all media asset URLs for the specified SKUs. ### Syntax `POST /cloudinary/products/media/get` ### Parameters Parameter|Type|Description --- |--- |--- skus|Array|**Required**. An array of product SKUs to return media for. ### Example Get media assets for product SKUs "my-product-sku1" and "my-product-sku2": ``` curl -X POST 'https://my-magento-shop.com/rest/V1/cloudinary/products/media/get' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ' \ -d '{ "skus": ["my-product-sku1","my-product-sku2"] }' ``` ### Sample response The response is returned as stringified JSON: ```json "{\"data\":{\"my-product-sku1\":{\"image\":\"https:\\/\\/res.cloudinary.com\\/myMagentoCloud\\/image\\/upload\\/c_lpad,d_sample.jpg,dpr_2.0,f_auto,q_auto\\/v1\\/media\\/catalog\\/product\\/w\\/t\\/my-product-sku_main_1.jpg\",\"small_image\":\"https:\\/\\/res.cloudinary.com\\/myMagentoCloud\\/image\\/upload\\/c_lpad,d_sample.jpg,dpr_2.0,f_auto,q_auto\\/v1\\/media\\/catalog\\/product\\/w\\/t\\/my-product-sku_main_1.jpg\",\"thumbnail\":\"https:\\/\\/res.cloudinary.com\\/myMagentoCloud\\/image\\/upload\\/c_lpad,d_sample.jpg,dpr_2.0,f_auto,q_auto\\/v1\\/media\\/catalog\\/product\\/w\\/t\\/my-product-sku_main_1.jpg\",\"media_gallery\":[\"https:\\/\\/res.cloudinary.com\\/myMagentoCloud\\/image\\/upload\\/c_lpad,d_sample.jpg,dpr_2.0,f_auto,q_auto\\/v1\\/media\\/catalog\\/product\\/w\\/t\\/my-product-sku_main_1.jpg\"]},\"my-product-sku2\":{\"image\":\"https:\\/\\/res.cloudinary.com\\/myMagentoCloud\\/image\\/upload\\/c_lpad,d_sample.jpg,dpr_2.0,f_auto,q_auto\\/v1\\/media\\/catalog\\/product\\/w\\/t\\/my-product-sku_main_1.jpg\",\"small_image\":\"https:\\/\\/res.cloudinary.com\\/myMagentoCloud\\/image\\/upload\\/c_lpad,d_sample.jpg,dpr_2.0,f_auto,q_auto\\/v1\\/media\\/catalog\\/product\\/w\\/t\\/my-product-sku_main_1.jpg\",\"thumbnail\":\"https:\\/\\/res.cloudinary.com\\/myMagentoCloud\\/image\\/upload\\/c_lpad,d_sample.jpg,dpr_2.0,f_auto,q_auto\\/v1\\/media\\/catalog\\/product\\/w\\/t\\/my-product-sku_main_1.jpg\",\"media_gallery\":[\"https:\\/\\/res.cloudinary.com\\/myMagentoCloud\\/image\\/upload\\/c_lpad,d_sample.jpg,dpr_2.0,f_auto,q_auto\\/v1\\/media\\/catalog\\/product\\/w\\/t\\/my-product-sku_main_1.jpg\"]}}}" ``` ## Add media to a SKU Adds media asset URLs to the specified SKU. ### Syntax `POST /cloudinary/products/:sku/media` ### Query parameters Parameter|Type|Description --- |--- |--- sku|String|**Required**. The product SKU to return media for. ### Body parameters Parameter|Type|Description --- |--- |--- urls|Array|**Required**. An array of [URL objects](#url_object_parameters), each containing Cloudinary URLs (and optionally public IDs) to add to a product. #### URL object parameters Parameter|Type|Description --- |--- |--- url|String|**Required**. The Cloudinary URL of the media to be added to a product. publicId|String|**Optional**. The Cloudinary public ID of the media to be added to a product. Only required if the Cloudinary URL does not contain a [version](advanced_url_delivery_options#asset_versions). roles | String or Array |**Optional**. The [product image role(s)](https://docs.magento.com/user-guide/catalog/product-image-upload.html#image-roles) of the image to be added to a product. Can be either an array of strings or a single string containing a comma separated list. label | String |**Optional**. The label associated with the image. Used as the alt text. disabled | Boolean | **Optional**. Whether the image should be hidden from the product page. **Default**: `false`. cldspinset | String | The tag name for the images to be used in a spinset. ### Example Add media assets for product SKU "my-product-sku": ``` curl -X POST 'https://my-magento-shop.com/rest/V1/cloudinary/products/my-product-sku/media' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ' \ -d '{ "urls": [ { "url": "https://res.cloudinary.com/myMagentoCloud/image/upload/e_blur:100,r_16/a_178/v1523871670/sample.jpg", "publicId": null, "disabled": 0, "label": "Some Alt Text" }, { "publicId": null, "disabled": 0, "label": "Some Alt Text", "cldspinset": "my-spinset-1" }, { "url": "https://res.cloudinary.com/myMagentoCloud/image/upload/e_blur:100,r_16/a_178/v1523871670/sample.jpg", "publicId": null, "disabled": 0, "label": "Some Alt Text", "cldspinset": "my-spinset-2" }, { "url": "https://res.cloudinary.com/myMagentoCloud/video/upload/v1563701653/sample.mp4", "publicId": null } ] }' ``` ### Sample response The response is returned as stringified JSON: ```json "{\"passed\":4,\"failed\":{\"count\":0,\"urls\":[]},\"message\":\"All items have been added to queue.\"}" ``` ## Add media for multiple SKUs Adds media asset URLs to multiple SKUs. ### Syntax `POST /cloudinary/productGallery/addItems` ### Parameters Parameter|Type|Description --- |--- |--- items|Array|**Required**. An array of [items objects](#items_object_parameters), each containing the SKU to add media to and the Cloudinary URLs (plus optionally public IDs) to add to the product. #### Items object parameters Parameter|Type|Description --- |--- |--- sku|String|**Required**. The product SKU to return media for. url|String|**Required**. The Cloudinary URL of the media to be added to a product. publicId|String|**Optional**. The Cloudinary public ID of the media to be added to a product. Only required if the Cloudinary URL does not contain a [version](advanced_url_delivery_options#asset_versions). roles | String or Array |**Optional**. The [product image role(s)](https://docs.magento.com/user-guide/catalog/product-image-upload.html#image-roles) of the image to be added to a product. Can be either an array of strings or a single string containing a comma separated list. label | String |**Optional**. The label associated with the image. Used as the alt text. disabled | Boolean |**Optional**. Whether the image should be hidden from the product page. **Default**: `false`. cldspinset | String | **Optional**. The tag name for the images to be used in a spinset. ### Example Add media assets for product SKUs "my-product-sku1" and "my-product-sku2": ``` curl -X POST 'https://my-magento-shop.com/rest/V1/cloudinary/productGallery/addItems' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ' \ -d '{ "items": [ { "url": "https://res.cloudinary.com/myMagentoCloud/image/upload/e_blur:100,r_16/a_178/v1523871670/sample.jpg", "sku": "my-product-sku1", "publicId": null, "disabled": 0, "label": "Some Alt Text" }, { "url": "https://res.cloudinary.com/myMagentoCloud/video/upload/v1563701653/sample.mp4", "sku": "my-product-sku2", "publicId": null } ] }' ``` ### Sample response The response is returned as stringified JSON: ```json "{\"errors\":0,\"items\":[{\"url\":\"https:\\/\\/res.cloudinary.com\\/myMagentoCloud\\/image\\/upload\\/e_blur:100,r_16\\/a_178\\/v1523871670\\/sample.jpg\",\"sku\":\"my-product-sku1\",\"publicId\":null,\"disabled\":0,\"label\":\"Some Alt Text\",\"error\":0,\"message\":\"The item was added to the queue.\"},{\"url\":\"https:\\/\\/res.cloudinary.com\\/myMagentoCloud\\/video\\/upload\\/v1563701653\\/sample.mp4\",\"sku\":\"my-product-sku2\",\"publicId\":null,\"error\":0,\"message\":\"The item was added to the queue.\"}],\"message\":\"All items have been added to queue.\"}" ``` ## Remove media from a SKU Removes media asset URLs from the specified SKU. ### Syntax `POST /cloudinary/products/:sku/mediaremove` ### Query parameters Parameter|Type|Description --- |--- |--- sku|String|**Required**. The product SKU to remove media from. ### Body parameters Parameter|Type|Description --- |--- |--- urls|Array|**Required**. An array of Cloudinary URLs to remove from a product. delete_all_gallery | Boolean | **Optional**. Whether to delete all media from a product. **Default**: `false`. ### Example Add media assets for product SKU "my-product-sku": ``` curl -X POST 'https://my-magento-shop.com/rest/V1/cloudinary/products/my-product-sku/mediaremove' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ' \ -d '{ "urls": [ "https://my-magento-shop.com/myMagentoCloud/image/upload/e_blur:100,r_16/a_178/v1523871670/sample1.jpg", "https://my-magento-shop.com/myMagentoCloud/image/upload/e_blur:100,r_16/a_178/v1523871670/sample2.jpg" "https://my-magento-shop.com/myMagentoCloud/image/upload/e_blur:100,r_16/a_178/v1523871670/sample3.jpg" ] }' ``` ### Sample response The response is returned as stringified JSON: ```json "{\"passed\":3,\"failed\":{\"count\":0,\"urls\":[]}}" ```